Cdn Mobile API

<back to all web services

WebAdRequest

Cdn.MobileApi

The following routes are available for this service:
GET/WebAdRequest
WebAdRequest Parameters:
NameParameterData TypeRequiredDescription
ImageUrlquerystringNo
ScreenNamequerystringNo
TitlequerystringNo
BodyTextquerystringNo
DestinationUrlquerystringNo
DevicequerystringNo
LocationsquerystringNo
StartDatequerystringNo
EndDatequerystringNo
SortOrderqueryintNo
DisplayCountqueryintNo
ClickCountqueryintNo
CustomerIdquerylongNo
ActiveOnlyqueryboolNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
WebAdResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<WebAdDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
WebAdDto Parameters:
NameParameterData TypeRequiredDescription
ImageUrlformstringNo
ScreenNameformstringNo
TitleformstringNo
BodyTextformstringNo
DestinationUrlformstringNo
DeviceformstringNo
LocationsformstringNo
StartDateformDateTimeNo
StartDateStrformstringNo
StartDayformintNo
StartMonthformintNo
StartYearformintNo
EndDateformDateTimeNo
EndDateStrformstringNo
EndDayformintNo
EndMonthformintNo
EndYearformintNo
SortOrderformintNo
DisplayCountformintNo
ClickCountformintNo
CustomerIdformlongNo
CustomerNameformstringNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
WebAdResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<WebAdDto>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.

GET /WebAdRequest HTTP/1.1 
Host: mobileapidevsw.greysheet.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			ImageUrl: String,
			ScreenName: String,
			Title: String,
			BodyText: String,
			DestinationUrl: String,
			Device: String,
			Locations: String,
			StartDate: 0001-01-01,
			StartDateStr: String,
			StartDay: 0,
			StartMonth: 0,
			StartYear: 0,
			EndDate: 0001-01-01,
			EndDateStr: String,
			EndDay: 0,
			EndMonth: 0,
			EndYear: 0,
			SortOrder: 0,
			DisplayCount: 0,
			ClickCount: 0,
			CustomerId: 0,
			CustomerName: String,
			Id: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}