Cdn API

<back to all web services

SpecialCollectionRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/SpecialCollectionRequest
SpecialCollectionRequest Parameters:
NameParameterData TypeRequiredDescription
ActiveOnlybodyboolNo
IncludeDeletedbodyboolNo
NamebodystringNo
DescriptionbodystringNo
SqlQuerybodystringNo
FontIconbodystringNo
TileImageUrlbodystringNo
TileTitlebodystringNo
SortOrderbodyintNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
SpecialCollectionResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<SpecialCollectionDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
SpecialCollectionDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DescriptionformstringNo
SqlQueryformstringNo
FontIconformstringNo
TileImageUrlformstringNo
TileTitleformstringNo
SortOrderformintNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
SpecialCollectionResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<SpecialCollectionDto>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 /SpecialCollectionRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ActiveOnly: False,
	IncludeDeleted: False,
	Name: String,
	Description: String,
	SqlQuery: String,
	FontIcon: String,
	TileImageUrl: String,
	TileTitle: String,
	SortOrder: 0,
	Id: 0,
	OrderBy: 
	[
		String
	],
	OrderDirections: 
	[
		Asc
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			Name: String,
			Description: String,
			SqlQuery: String,
			FontIcon: String,
			TileImageUrl: String,
			TileTitle: String,
			SortOrder: 0,
			Id: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}