Needio.Services

<back to all web services

GetCampaignListsRequest

The following routes are available for this service:
All Verbs/Campaign/GetCampaignLists
GetCampaignListsRequest Parameters:
NameParameterData TypeRequiredDescription
RecordCountqueryintNo
PagequeryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetCampaignListsResponse Parameters:
NameParameterData TypeRequiredDescription
CampaignListsformList<CampaignListDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
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
GetCampaignListsResponse Parameters:
NameParameterData TypeRequiredDescription
CampaignListsformList<CampaignListDto>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"RecordCount":0,"Page":0,"start":"\/Date(1635159186426+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CampaignLists":[{"CampaignId":0,"CampaignCode":"String","Description":"String","CampaignType":0,"BeginDate":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","ActiveYn":false,"Message":"String","MediaUrl":"String","LogoUrl":"String"}],"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}