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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	item: 
	{
		currentCampaignNumber: 0,
		priorYearCampaignNumber: 0,
		campaigns: 
		[
			{
				campaignNumber: 0,
				campaignName: String,
				batchNumber: 0,
				batchName: String,
				campaignsAwayFromCurrent: 0,
				cycle: 0,
				periodStartTime: 0001-01-01T00:00:00,
				periodEndTime: 0001-01-01T00:00:00,
				fiscalYear: 0,
				status: String
			}
		]
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}