Cdn API - CPG Source

<back to all web services

WebHomeBannerRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/WebHomeBannerRequest
WebHomeBannerRequest Parameters:
NameParameterData TypeRequiredDescription
ImageUrlbodystringNo
ScreenNamebodystringNo
HeadlinebodystringNo
ButtonTextbodystringNo
DestinationUrlbodystringNo
LoginStatusbodystringNo
StartDatebodystringNo
EndDatebodystringNo
SortOrderbodyintNo
DisplayCountbodyintNo
ClickCountbodyintNo
CustomerIdbodylongNo
ActiveOnlybodyboolNo
AdminActiveOnlybodyboolNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
WebHomeBannerResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<WebHomeBannerDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
WebHomeBannerDto Parameters:
NameParameterData TypeRequiredDescription
ImageUrlformstringNo
ScreenNameformstringNo
HeadlineformstringNo
ButtonTextformstringNo
DestinationUrlformstringNo
LoginStatusformstringNo
StartDateformDateTimeNo
StartDateStrformstringNo
StartDayformintNo
StartMonthformintNo
StartYearformintNo
EndDateformDateTimeNo
EndDateStrformstringNo
EndDayformintNo
EndMonthformintNo
EndYearformintNo
SortOrderformintNo
DisplayCountformintNo
ClickCountformintNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
WebHomeBannerResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<WebHomeBannerDto>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
Content-Length: length

{"Data":[{"ImageUrl":"String","ScreenName":"String","Headline":"String","ButtonText":"String","DestinationUrl":"String","LoginStatus":"String","StartDate":"\/Date(-62135596800000-0000)\/","StartDateStr":"String","StartDay":0,"StartMonth":0,"StartYear":0,"EndDate":"\/Date(-62135596800000-0000)\/","EndDateStr":"String","EndDay":0,"EndMonth":0,"EndYear":0,"SortOrder":0,"DisplayCount":0,"ClickCount":0,"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}