Cdn API - CPG Source

<back to all web services

WebHeroBannerRequest

Cdn.Api

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

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /WebHeroBannerRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ImageUrl":"String","ScreenName":"String","Headline1":"String","Headline2":"String","DestinationUrl":"String","LoginStatus":"String","StartDate":"String","EndDate":"String","SortOrder":0,"DisplayCount":0,"ClickCount":0,"CustomerId":0,"ActiveOnly":false,"Id":0,"OrderBy":["String"],"OrderDirections":["Asc"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Data":[{"ImageUrl":"String","ScreenName":"String","Headline1":"String","Headline2":"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,"CustomerId":0,"CustomerName":"String","Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}