Needio.Services.ExtApiHost

<back to all web services

ExtGetSmCategoriesRequest

The following routes are available for this service:
All Verbs/Ext/GetSmCategories/
ExtGetSmCategoriesRequest Parameters:
NameParameterData TypeRequiredDescription
PostTypeIdqueryintNo
ModifiedSincequeryDateTime?No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
isAdminformboolNo
CmdformstringNo
ExtGetSmCategoriesResponse Parameters:
NameParameterData TypeRequiredDescription
CategoriesformList<SmCategoryInfoDTO>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ExYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
SmCategoryInfoDTO Parameters:
NameParameterData TypeRequiredDescription
CategoryIdformintNo
NameformstringNo
CodeformstringNo
PIdformshort?No
ActiveYnformboolNo
TagsformstringNo
TitleformstringNo
KeywordsformstringNo
MetadataformstringNo
CategoryLabelformstringNo
ExtGetSmCategoriesResponse Parameters:
NameParameterData TypeRequiredDescription
CategoriesformList<SmCategoryInfoDTO>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 /Ext/GetSmCategories/ HTTP/1.1 
Host: apiservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ExtGetSmCategoriesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <ModifiedSince>0001-01-01T00:00:00</ModifiedSince>
  <PostTypeId>0</PostTypeId>
</ExtGetSmCategoriesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ExtGetSmCategoriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
    <ExYn>false</ExYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Categories xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:SmCategoryInfoDTO>
      <d2p1:ActiveYn>false</d2p1:ActiveYn>
      <d2p1:CategoryId>0</d2p1:CategoryId>
      <d2p1:CategoryLabel>String</d2p1:CategoryLabel>
      <d2p1:Code>String</d2p1:Code>
      <d2p1:Keywords>String</d2p1:Keywords>
      <d2p1:Metadata>String</d2p1:Metadata>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PId>0</d2p1:PId>
      <d2p1:Tags>String</d2p1:Tags>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:SmCategoryInfoDTO>
  </Categories>
</ExtGetSmCategoriesResponse>