NAV

<back to all web services

CampaignsGetList

The following routes are available for this service:
GET/campaigns
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class CampaignsGetList
    {
        
    }

    public static class CampaignsGetListResponse extends GetResponse<CampaignViewModel>
    {
        
    }

    public static class GetResponse<TEntity>
    {
        public TEntity item = null;
        public ResponseStatus responseStatus = null;
        
        public TEntity getItem() { return item; }
        public GetResponse<TEntity> setItem(TEntity value) { this.item = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetResponse<TEntity> setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class CampaignViewModel
    {
        public Integer currentCampaignNumber = null;
        public Integer priorYearCampaignNumber = null;
        public ArrayList<CampaignDetails> campaigns = null;
        
        public Integer getCurrentCampaignNumber() { return currentCampaignNumber; }
        public CampaignViewModel setCurrentCampaignNumber(Integer value) { this.currentCampaignNumber = value; return this; }
        public Integer getPriorYearCampaignNumber() { return priorYearCampaignNumber; }
        public CampaignViewModel setPriorYearCampaignNumber(Integer value) { this.priorYearCampaignNumber = value; return this; }
        public ArrayList<CampaignDetails> getCampaigns() { return campaigns; }
        public CampaignViewModel setCampaigns(ArrayList<CampaignDetails> value) { this.campaigns = value; return this; }
    }

    public static class CampaignDetails
    {
        public Integer campaignNumber = null;
        public String campaignName = null;
        public BigDecimal batchNumber = null;
        public String batchName = null;
        public Integer campaignsAwayFromCurrent = null;
        public Integer cycle = null;
        public Date periodStartTime = null;
        public Date periodEndTime = null;
        public Integer fiscalYear = null;
        public String status = null;
        
        public Integer getCampaignNumber() { return campaignNumber; }
        public CampaignDetails setCampaignNumber(Integer value) { this.campaignNumber = value; return this; }
        public String getCampaignName() { return campaignName; }
        public CampaignDetails setCampaignName(String value) { this.campaignName = value; return this; }
        public BigDecimal getBatchNumber() { return batchNumber; }
        public CampaignDetails setBatchNumber(BigDecimal value) { this.batchNumber = value; return this; }
        public String getBatchName() { return batchName; }
        public CampaignDetails setBatchName(String value) { this.batchName = value; return this; }
        public Integer getCampaignsAwayFromCurrent() { return campaignsAwayFromCurrent; }
        public CampaignDetails setCampaignsAwayFromCurrent(Integer value) { this.campaignsAwayFromCurrent = value; return this; }
        public Integer getCycle() { return cycle; }
        public CampaignDetails setCycle(Integer value) { this.cycle = value; return this; }
        public Date getPeriodStartTime() { return periodStartTime; }
        public CampaignDetails setPeriodStartTime(Date value) { this.periodStartTime = value; return this; }
        public Date getPeriodEndTime() { return periodEndTime; }
        public CampaignDetails setPeriodEndTime(Date value) { this.periodEndTime = value; return this; }
        public Integer getFiscalYear() { return fiscalYear; }
        public CampaignDetails setFiscalYear(Integer value) { this.fiscalYear = value; return this; }
        public String getStatus() { return status; }
        public CampaignDetails setStatus(String value) { this.status = value; return this; }
    }

}

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