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

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

{
	RecordCount: 0,
	Page: 0,
	start: 2021-10-21T01:05:02.5128381+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CampaignLists: 
	[
		{
			CampaignId: 0,
			CampaignCode: String,
			Description: String,
			CampaignType: 0,
			BeginDate: 0001-01-01,
			EndDate: 0001-01-01,
			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
	}
}