Cdn API

<back to all web services

SpecialCollectionRequest

Cdn.Api

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 .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>

<SpecialCollectionRequest 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>
  <Description>String</Description>
  <FontIcon>String</FontIcon>
  <IncludeDeleted>false</IncludeDeleted>
  <Name>String</Name>
  <SortOrder>0</SortOrder>
  <SqlQuery>String</SqlQuery>
  <TileImageUrl>String</TileImageUrl>
  <TileTitle>String</TileTitle>
</SpecialCollectionRequest>

    </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>

<SpecialCollectionResponse 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:SpecialCollectionDto>
      <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:Description>String</d2p1:Description>
      <d2p1:FontIcon>String</d2p1:FontIcon>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:SortOrder>0</d2p1:SortOrder>
      <d2p1:SqlQuery>String</d2p1:SqlQuery>
      <d2p1:TileImageUrl>String</d2p1:TileImageUrl>
      <d2p1:TileTitle>String</d2p1:TileTitle>
    </d2p1:SpecialCollectionDto>
  </Data>
</SpecialCollectionResponse>

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