Needio.Services

GetKbCategoriesRequest

The following routes are available for this service:
All Verbs	/KB/GetKbCategories/

**GetKbCategoriesRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CategoryId	query	int	No
SearchText	query	string	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required
start	form	DateTime	No
DeviceUUID	form	string	No
APIKey	form	string	No
isAdmin	form	bool	No
Cmd	form	string	No

**GetKbCategoriesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
KBCategories	form	List<KbCategoryDTO>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Result	form	bool	No
ResMessage	form	string	No
Error	form	Error	No
PageInfo	form	BasePageInfo	No

**Error** Parameters:
Name	Parameter	Data Type	Required
ErrorYn	form	bool	No
ExYn	form	bool	No
ErrorCode	form	string	No
ErrorDescription	form	string	No

**BasePageInfo** Parameters:
Name	Parameter	Data Type	Required
TotalRecordCount	form	int	No
TotalPageCount	form	int	No
CurrentPage	form	int	No

**KbCategoryDTO** Parameters:
Name	Parameter	Data Type	Required
CategoryId	form	int	No
Name	form	string	No
IsHot	form	bool	No
Parent	form	int?	No
SefName	form	string	No
Author	form	long	No
Icon	form	string	No
Articles	form	List<KbArticleDTO>	No
SubCategories	form	List<KbCategoryDTO>	No

**KbArticleDTO** Parameters:
Name	Parameter	Data Type	Required
ArticleId	form	long	No
Title	form	string	No
Content	form	string	No
Views	form	int	No
Likes	form	int	No
Created	form	DateTime?	No
Edited	form	DateTime?	No
IsDraft	form	int	No
PublishStartDate	form	DateTime?	No
PublishEndDate	form	DateTime?	No
Author	form	long	No
CategoryId	form	int	No
SefName	form	string	No
NeedionName	form	string	No

**GetKbCategoriesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
KBCategories	form	List<KbCategoryDTO>	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 /KB/GetKbCategories/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetKbCategoriesRequest 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>
  <CategoryId>0</CategoryId>
  <SearchText>String</SearchText>
</GetKbCategoriesRequest>

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

<GetKbCategoriesResponse 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>
  <KBCategories xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:KbCategoryDTO>
      <d2p1:Articles>
        <d2p1:KbArticleDTO>
          <d2p1:ArticleId>0</d2p1:ArticleId>
          <d2p1:Author>0</d2p1:Author>
          <d2p1:CategoryId>0</d2p1:CategoryId>
          <d2p1:Content>String</d2p1:Content>
          <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
          <d2p1:Edited>0001-01-01T00:00:00</d2p1:Edited>
          <d2p1:IsDraft>0</d2p1:IsDraft>
          <d2p1:Likes>0</d2p1:Likes>
          <d2p1:NeedionName>String</d2p1:NeedionName>
          <d2p1:PublishEndDate>0001-01-01T00:00:00</d2p1:PublishEndDate>
          <d2p1:PublishStartDate>0001-01-01T00:00:00</d2p1:PublishStartDate>
          <d2p1:SefName>String</d2p1:SefName>
          <d2p1:Title>String</d2p1:Title>
          <d2p1:Views>0</d2p1:Views>
        </d2p1:KbArticleDTO>
      </d2p1:Articles>
      <d2p1:Author>0</d2p1:Author>
      <d2p1:CategoryId>0</d2p1:CategoryId>
      <d2p1:Icon>String</d2p1:Icon>
      <d2p1:IsHot>false</d2p1:IsHot>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Parent>0</d2p1:Parent>
      <d2p1:SefName>String</d2p1:SefName>
      <d2p1:SubCategories>
        <d2p1:KbCategoryDTO>
          <d2p1:Articles>
            <d2p1:KbArticleDTO>
              <d2p1:ArticleId>0</d2p1:ArticleId>
              <d2p1:Author>0</d2p1:Author>
              <d2p1:CategoryId>0</d2p1:CategoryId>
              <d2p1:Content>String</d2p1:Content>
              <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
              <d2p1:Edited>0001-01-01T00:00:00</d2p1:Edited>
              <d2p1:IsDraft>0</d2p1:IsDraft>
              <d2p1:Likes>0</d2p1:Likes>
              <d2p1:NeedionName>String</d2p1:NeedionName>
              <d2p1:PublishEndDate>0001-01-01T00:00:00</d2p1:PublishEndDate>
              <d2p1:PublishStartDate>0001-01-01T00:00:00</d2p1:PublishStartDate>
              <d2p1:SefName>String</d2p1:SefName>
              <d2p1:Title>String</d2p1:Title>
              <d2p1:Views>0</d2p1:Views>
            </d2p1:KbArticleDTO>
          </d2p1:Articles>
          <d2p1:Author>0</d2p1:Author>
          <d2p1:CategoryId>0</d2p1:CategoryId>
          <d2p1:Icon>String</d2p1:Icon>
          <d2p1:IsHot>false</d2p1:IsHot>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Parent>0</d2p1:Parent>
          <d2p1:SefName>String</d2p1:SefName>
          <d2p1:SubCategories>
            <d2p1:KbCategoryDTO>
              <d2p1:Articles>
                <d2p1:KbArticleDTO>
                  <d2p1:ArticleId>0</d2p1:ArticleId>
                  <d2p1:Author>0</d2p1:Author>
                  <d2p1:CategoryId>0</d2p1:CategoryId>
                  <d2p1:Content>String</d2p1:Content>
                  <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
                  <d2p1:Edited>0001-01-01T00:00:00</d2p1:Edited>
                  <d2p1:IsDraft>0</d2p1:IsDraft>
                  <d2p1:Likes>0</d2p1:Likes>
                  <d2p1:NeedionName>String</d2p1:NeedionName>
                  <d2p1:PublishEndDate>0001-01-01T00:00:00</d2p1:PublishEndDate>
                  <d2p1:PublishStartDate>0001-01-01T00:00:00</d2p1:PublishStartDate>
                  <d2p1:SefName>String</d2p1:SefName>
                  <d2p1:Title>String</d2p1:Title>
                  <d2p1:Views>0</d2p1:Views>
                </d2p1:KbArticleDTO>
              </d2p1:Articles>
              <d2p1:Author>0</d2p1:Author>
              <d2p1:CategoryId>0</d2p1:CategoryId>
              <d2p1:Icon>String</d2p1:Icon>
              <d2p1:IsHot>false</d2p1:IsHot>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:Parent>0</d2p1:Parent>
              <d2p1:SefName>String</d2p1:SefName>
              <d2p1:SubCategories i:nil="true" />
            </d2p1:KbCategoryDTO>
          </d2p1:SubCategories>
        </d2p1:KbCategoryDTO>
      </d2p1:SubCategories>
    </d2p1:KbCategoryDTO>
  </KBCategories>
</GetKbCategoriesResponse>