NAV

CampaignsGetList

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class CampaignsGetList
{
}

open class CampaignsGetListResponse : GetResponse<CampaignViewModel>()
{
}

open class GetResponse<TEntity>
{
    var item:TEntity? = null
    var responseStatus:ResponseStatus? = null
}

open class CampaignViewModel
{
    var currentCampaignNumber:Int? = null
    var priorYearCampaignNumber:Int? = null
    var campaigns:ArrayList<CampaignDetails> = ArrayList<CampaignDetails>()
}

open class CampaignDetails
{
    var campaignNumber:Int? = null
    var campaignName:String? = null
    var batchNumber:BigDecimal? = null
    var batchName:String? = null
    var campaignsAwayFromCurrent:Int? = null
    var cycle:Int? = null
    var periodStartTime:Date? = null
    var periodEndTime:Date? = null
    var fiscalYear:Int? = null
    var status:String? = null
}

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