Cdn API - CPG Source

<back to all web services

WebHomeBannerRequest

Cdn.Api

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 .soap12 suffix or ?format=soap12

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: cdnapidev.greysheet.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<WebHomeBannerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.RequestObjects">
  <Id>0</Id>
  <OrderBy xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OrderBy>
  <OrderDirections>
    <SortOrders>Asc</SortOrders>
  </OrderDirections>
  <ActiveOnly>false</ActiveOnly>
  <AdminActiveOnly>false</AdminActiveOnly>
  <ButtonText>String</ButtonText>
  <ClickCount>0</ClickCount>
  <CustomerId>0</CustomerId>
  <DestinationUrl>String</DestinationUrl>
  <DisplayCount>0</DisplayCount>
  <EndDate>String</EndDate>
  <Headline>String</Headline>
  <ImageUrl>String</ImageUrl>
  <LoginStatus>String</LoginStatus>
  <ScreenName>String</ScreenName>
  <SortOrder>0</SortOrder>
  <StartDate>String</StartDate>
</WebHomeBannerRequest>

    </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<WebHomeBannerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cdn.Api.ResponseObjects">
  <CachedResponse>false</CachedResponse>
  <ErrorText>String</ErrorText>
  <OpCode>0</OpCode>
  <RequestTime>String</RequestTime>
  <ResponseTime>String</ResponseTime>
  <Total>0</Total>
  <TotalExecutionTime>String</TotalExecutionTime>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cdn.Api.Dto">
    <d2p1:WebHomeBannerDto>
      <d2p1:_x003C_Active_x003E_k__BackingField>false</d2p1:_x003C_Active_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>0</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_LastModBy_x003E_k__BackingField>String</d2p1:_x003C_LastModBy_x003E_k__BackingField>
      <d2p1:_x003C_LastMod_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastMod_x003E_k__BackingField>
      <d2p1:ButtonText>String</d2p1:ButtonText>
      <d2p1:ClickCount>0</d2p1:ClickCount>
      <d2p1:DestinationUrl>String</d2p1:DestinationUrl>
      <d2p1:DisplayCount>0</d2p1:DisplayCount>
      <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
      <d2p1:EndDateStr>String</d2p1:EndDateStr>
      <d2p1:EndDay>0</d2p1:EndDay>
      <d2p1:EndMonth>0</d2p1:EndMonth>
      <d2p1:EndYear>0</d2p1:EndYear>
      <d2p1:Headline>String</d2p1:Headline>
      <d2p1:ImageUrl>String</d2p1:ImageUrl>
      <d2p1:LoginStatus>String</d2p1:LoginStatus>
      <d2p1:ScreenName>String</d2p1:ScreenName>
      <d2p1:SortOrder>0</d2p1:SortOrder>
      <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
      <d2p1:StartDateStr>String</d2p1:StartDateStr>
      <d2p1:StartDay>0</d2p1:StartDay>
      <d2p1:StartMonth>0</d2p1:StartMonth>
      <d2p1:StartYear>0</d2p1:StartYear>
    </d2p1:WebHomeBannerDto>
  </Data>
</WebHomeBannerResponse>

    </soap12:Body>
</soap12:Envelope>