Needio.Services

GetCampaignListsRequest

The following routes are available for this service:
All Verbs	/Campaign/GetCampaignLists

**GetCampaignListsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
RecordCount	query	int	No
Page	query	int	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required
start	form	DateTime	No
DeviceUUID	form	string	No
APIKey	form	string	No
isAdmin	form	bool	No
Cmd	form	string	No

**GetCampaignListsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CampaignLists	form	List<CampaignListDto>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Result	form	bool	No
ResMessage	form	string	No
Error	form	Error	No
PageInfo	form	BasePageInfo	No

**Error** Parameters:
Name	Parameter	Data Type	Required
ErrorYn	form	bool	No
ExYn	form	bool	No
ErrorCode	form	string	No
ErrorDescription	form	string	No

**BasePageInfo** Parameters:
Name	Parameter	Data Type	Required
TotalRecordCount	form	int	No
TotalPageCount	form	int	No
CurrentPage	form	int	No

**CampaignListDto** Parameters:
Name	Parameter	Data Type	Required
CampaignId	form	int	No
CampaignCode	form	string	No
Description	form	string	No
CampaignType	form	CampaignTypes	No
BeginDate	form	DateTime	No
EndDate	form	DateTime	No
ActiveYn	form	bool	No
Message	form	string	No
MediaUrl	form	string	No
LogoUrl	form	string	No

**CampaignTypes** Enum:
Name	Value
OnlyList	0
SameProduct	1
DifferentProduct	2
AnyProduct	3
Custom	4
BasketDiscount	11
StoreDiscount	12

**GetCampaignListsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CampaignLists	form	List<CampaignListDto>	No

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.

POST /Campaign/GetCampaignLists HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetCampaignListsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <Page>0</Page>
  <RecordCount>0</RecordCount>
</GetCampaignListsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCampaignListsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
    <ExYn>false</ExYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <CampaignLists xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:CampaignListDto>
      <d2p1:ActiveYn>false</d2p1:ActiveYn>
      <d2p1:BeginDate>0001-01-01T00:00:00</d2p1:BeginDate>
      <d2p1:CampaignCode>String</d2p1:CampaignCode>
      <d2p1:CampaignId>0</d2p1:CampaignId>
      <d2p1:CampaignType>OnlyList</d2p1:CampaignType>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
      <d2p1:LogoUrl>String</d2p1:LogoUrl>
      <d2p1:MediaUrl>String</d2p1:MediaUrl>
      <d2p1:Message>String</d2p1:Message>
    </d2p1:CampaignListDto>
  </CampaignLists>
</GetCampaignListsResponse>