Cdn API - CPG Source

SpecialCollectionRequest

Cdn.Api

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

**SpecialCollectionRequest** Parameters:
Name	Parameter	Data Type	Required
ActiveOnly	body	bool	No
IncludeDeleted	body	bool	No
Name	body	string	No
Description	body	string	No
SqlQuery	body	string	No
FontIcon	body	string	No
TileImageUrl	body	string	No
TileTitle	body	string	No
SortOrder	body	int	No

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

**SpecialCollectionResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<SpecialCollectionDto>	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

**SpecialCollectionDto** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Description	form	string	No
SqlQuery	form	string	No
FontIcon	form	string	No
TileImageUrl	form	string	No
TileTitle	form	string	No
SortOrder	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

**SpecialCollectionResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<SpecialCollectionDto>	No

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

HTTP + XML

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

POST /SpecialCollectionRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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