NAV

CampaignsGetList

The following routes are available for this service:
GET	/campaigns


export class CampaignDetails
{
    public campaignNumber?: number;
    public campaignName?: string;
    public batchNumber?: number;
    public batchName?: string;
    public campaignsAwayFromCurrent?: number;
    public cycle?: number;
    public periodStartTime?: string;
    public periodEndTime?: string;
    public fiscalYear?: number;
    public status?: string;

    public constructor(init?: Partial<CampaignDetails>) { (Object as any).assign(this, init); }
}

export class CampaignViewModel
{
    public currentCampaignNumber?: number;
    public priorYearCampaignNumber?: number;
    public campaigns?: CampaignDetails[];

    public constructor(init?: Partial<CampaignViewModel>) { (Object as any).assign(this, init); }
}

export class CampaignsGetListResponse extends GetResponse<CampaignViewModel>
{

    public constructor(init?: Partial<CampaignsGetListResponse>) { super(init); (Object as any).assign(this, init); }
}

export class CampaignsGetList
{

    public constructor(init?: Partial<CampaignsGetList>) { (Object as any).assign(this, init); }
}

export class GetResponse<TEntity>
{
    public item?: TEntity;
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<GetResponse<TEntity>>) { (Object as any).assign(this, init); }
}

TypeScript CampaignsGetList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /campaigns HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignsGetListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <Item>
    <Campaigns>
      <CampaignDetails>
        <BatchName>String</BatchName>
        <BatchNumber>0</BatchNumber>
        <CampaignName>String</CampaignName>
        <CampaignNumber>0</CampaignNumber>
        <CampaignsAwayFromCurrent>0</CampaignsAwayFromCurrent>
        <Cycle>0</Cycle>
        <FiscalYear>0</FiscalYear>
        <PeriodEndTime>0001-01-01T00:00:00</PeriodEndTime>
        <PeriodStartTime>0001-01-01T00:00:00</PeriodStartTime>
        <Status>String</Status>
      </CampaignDetails>
    </Campaigns>
    <CurrentCampaignNumber>0</CurrentCampaignNumber>
    <PriorYearCampaignNumber>0</PriorYearCampaignNumber>
  </Item>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CampaignsGetListResponse>