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