Needio.Services

<back to all web services

GetCampaignFromCodeRequest

The following routes are available for this service:
All Verbs/Campaign/GetCampaignFromCode
GetCampaignFromCodeRequest Parameters:
NameParameterData TypeRequiredDescription
CampaignCodequerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
isAdminformboolNo
CmdformstringNo
GetCampaignFromCodeResponse Parameters:
NameParameterData TypeRequiredDescription
CampaignformCampaignListDtoNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ExYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
CampaignListDto Parameters:
NameParameterData TypeRequiredDescription
CampaignIdformintNo
CampaignCodeformstringNo
DescriptionformstringNo
CampaignTypeformCampaignTypesNo
BeginDateformDateTimeNo
EndDateformDateTimeNo
ActiveYnformboolNo
MessageformstringNo
MediaUrlformstringNo
LogoUrlformstringNo
CampaignTypes Enum:
NameValue
OnlyList0
SameProduct1
DifferentProduct2
AnyProduct3
Custom4
BasketDiscount11
StoreDiscount12
GetCampaignFromCodeResponse Parameters:
NameParameterData TypeRequiredDescription
CampaignformCampaignListDtoNo

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/GetCampaignFromCode HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetCampaignFromCodeRequest 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>
  <CampaignCode>String</CampaignCode>
</GetCampaignFromCodeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCampaignFromCodeResponse 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>
  <Campaign xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <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>
  </Campaign>
</GetCampaignFromCodeResponse>