Cdn API

<back to all web services

XCategoriesRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/XCategoriesRequest
XCategoriesRequest Parameters:
NameParameterData TypeRequiredDescription
CategoryNamebodystringNo
CategoryPermaLinkbodystringNo
IconbodystringNo
IsValidDealerDirectorybodyboolNo
IsValidEventsbodyboolNo
IsValidBlogbodyboolNo
DealerDirectoryOnlybodyboolNo
EventsOnlybodyboolNo
BlogOnlybodyboolNo
SortOrderbodyintNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
XCategoriesResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<XCategoryDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
XCategoryDto Parameters:
NameParameterData TypeRequiredDescription
CategoryNameformstringNo
CategoryPermaLinkformstringNo
IconformstringNo
IsValidDealerDirectoryformboolNo
IsValidEventsformboolNo
IsValidBlogformboolNo
SortOrderformintNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
XCategoriesResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<XCategoryDto>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 /XCategoriesRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<XCategoriesRequest 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>
  <BlogOnly>false</BlogOnly>
  <CategoryName>String</CategoryName>
  <CategoryPermaLink>String</CategoryPermaLink>
  <DealerDirectoryOnly>false</DealerDirectoryOnly>
  <EventsOnly>false</EventsOnly>
  <Icon>String</Icon>
  <IsValidBlog>false</IsValidBlog>
  <IsValidDealerDirectory>false</IsValidDealerDirectory>
  <IsValidEvents>false</IsValidEvents>
  <SortOrder>0</SortOrder>
</XCategoriesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<XCategoriesResponse 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:XCategoryDto>
      <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:_x003C_CategoryName_x003E_k__BackingField>String</d2p1:_x003C_CategoryName_x003E_k__BackingField>
      <d2p1:_x003C_CategoryPermaLink_x003E_k__BackingField>String</d2p1:_x003C_CategoryPermaLink_x003E_k__BackingField>
      <d2p1:_x003C_Icon_x003E_k__BackingField>String</d2p1:_x003C_Icon_x003E_k__BackingField>
      <d2p1:_x003C_IsValidBlog_x003E_k__BackingField>false</d2p1:_x003C_IsValidBlog_x003E_k__BackingField>
      <d2p1:_x003C_IsValidDealerDirectory_x003E_k__BackingField>false</d2p1:_x003C_IsValidDealerDirectory_x003E_k__BackingField>
      <d2p1:_x003C_IsValidEvents_x003E_k__BackingField>false</d2p1:_x003C_IsValidEvents_x003E_k__BackingField>
      <d2p1:_x003C_SortOrder_x003E_k__BackingField>0</d2p1:_x003C_SortOrder_x003E_k__BackingField>
    </d2p1:XCategoryDto>
  </Data>
</XCategoriesResponse>