Cdn API

<back to all web services

PdfAdRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/PdfAdRequest
PdfAdRequest Parameters:
NameParameterData TypeRequiredDescription
PdfFileNamebodystringNo
ScreenNamebodystringNo
PublicationbodystringNo
DestinationUrlbodystringNo
StartDatebodystringNo
EndDatebodystringNo
SortOrderbodyintNo
CustomerIdbodylongNo
ActiveOnlybodyboolNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
PdfAdResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<PdfAdDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
PdfAdDto Parameters:
NameParameterData TypeRequiredDescription
PdfFileNameformstringNo
ScreenNameformstringNo
PublicationformstringNo
DestinationUrlformstringNo
StartDateformDateTimeNo
StartDateStrformstringNo
EndDateformDateTimeNo
EndDateStrformstringNo
SortOrderformintNo
DisplayCountPublicationformintNo
DisplayCountTotalformintNo
CustomerIdformlongNo
CustomerNameformstringNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
PdfAdResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<PdfAdDto>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 /PdfAdRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PdfFileName: String,
	ScreenName: String,
	Publication: String,
	DestinationUrl: String,
	StartDate: String,
	EndDate: String,
	SortOrder: 0,
	CustomerId: 0,
	ActiveOnly: False,
	Id: 0,
	OrderBy: 
	[
		String
	],
	OrderDirections: 
	[
		Asc
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			PdfFileName: String,
			ScreenName: String,
			Publication: String,
			DestinationUrl: String,
			StartDate: 0001-01-01,
			StartDateStr: String,
			EndDate: 0001-01-01,
			EndDateStr: String,
			SortOrder: 0,
			DisplayCountPublication: 0,
			DisplayCountTotal: 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
}