Cdn API - CPG Source

WebHomeBannerRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE	/WebHomeBannerRequest

**WebHomeBannerRequest** Parameters:
Name	Parameter	Data Type	Required
ImageUrl	body	string	No
ScreenName	body	string	No
Headline	body	string	No
ButtonText	body	string	No
DestinationUrl	body	string	No
LoginStatus	body	string	No
StartDate	body	string	No
EndDate	body	string	No
SortOrder	body	int	No
DisplayCount	body	int	No
ClickCount	body	int	No
CustomerId	body	long	No
ActiveOnly	body	bool	No
AdminActiveOnly	body	bool	No

**BaseRequest<T>** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
OrderBy	form	string[]	No
OrderDirections	form	SortOrders[]	No

**WebHomeBannerResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<WebHomeBannerDto>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No

**WebHomeBannerDto** Parameters:
Name	Parameter	Data Type	Required
ImageUrl	form	string	No
ScreenName	form	string	No
Headline	form	string	No
ButtonText	form	string	No
DestinationUrl	form	string	No
LoginStatus	form	string	No
StartDate	form	DateTime	No
StartDateStr	form	string	No
StartDay	form	int	No
StartMonth	form	int	No
StartYear	form	int	No
EndDate	form	DateTime	No
EndDateStr	form	string	No
EndDay	form	int	No
EndMonth	form	int	No
EndYear	form	int	No
SortOrder	form	int	No
DisplayCount	form	int	No
ClickCount	form	int	No

**DtoBase** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Active	form	bool	No
LastMod	form	DateTime	No
LastModBy	form	string	No

**WebHomeBannerResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<WebHomeBannerDto>	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 /WebHomeBannerRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ImageUrl: String,
	ScreenName: String,
	Headline: String,
	ButtonText: String,
	DestinationUrl: String,
	LoginStatus: String,
	StartDate: String,
	EndDate: String,
	SortOrder: 0,
	DisplayCount: 0,
	ClickCount: 0,
	CustomerId: 0,
	ActiveOnly: False,
	AdminActiveOnly: False,
	Id: 0,
	OrderBy: 
	[
		String
	],
	OrderDirections: 
	[
		Asc
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			ImageUrl: String,
			ScreenName: String,
			Headline: String,
			ButtonText: String,
			DestinationUrl: String,
			LoginStatus: 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,
			Id: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}