NAV

CampaignsGetList

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

**GetResponse<TEntity>** Parameters:
Name	Parameter	Data Type	Required	Description
Item	form	TEntity	No
ResponseStatus	form	ResponseStatus	No

**CampaignViewModel** Parameters:
Name	Parameter	Data Type	Required
CurrentCampaignNumber	form	int	No
PriorYearCampaignNumber	form	int	No
Campaigns	form	List<CampaignDetails>	No

**CampaignDetails** Parameters:
Name	Parameter	Data Type	Required
CampaignNumber	form	int	No
CampaignName	form	string	No
BatchNumber	form	decimal	No
BatchName	form	string	No
CampaignsAwayFromCurrent	form	int	No
Cycle	form	int	No
PeriodStartTime	form	DateTime	No
PeriodEndTime	form	DateTime	No
FiscalYear	form	int	No
Status	form	string	No

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
		}
	}
}