Needio.Services

<back to all web services

GetKbCategoriesRequest

The following routes are available for this service:
All Verbs/KB/GetKbCategories/
GetKbCategoriesRequest Parameters:
NameParameterData TypeRequiredDescription
CategoryIdqueryintNo
SearchTextquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
GetKbCategoriesResponse Parameters:
NameParameterData TypeRequiredDescription
KBCategoriesformList<KbCategoryDTO>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
KbCategoryDTO Parameters:
NameParameterData TypeRequiredDescription
CategoryIdformintNo
NameformstringNo
IsHotformboolNo
Parentformint?No
SefNameformstringNo
AuthorformlongNo
IconformstringNo
ArticlesformList<KbArticleDTO>No
SubCategoriesformList<KbCategoryDTO>No
KbArticleDTO Parameters:
NameParameterData TypeRequiredDescription
ArticleIdformlongNo
TitleformstringNo
ContentformstringNo
ViewsformintNo
LikesformintNo
CreatedformDateTime?No
EditedformDateTime?No
IsDraftformintNo
PublishStartDateformDateTime?No
PublishEndDateformDateTime?No
AuthorformlongNo
CategoryIdformintNo
SefNameformstringNo
NeedionNameformstringNo
GetKbCategoriesResponse Parameters:
NameParameterData TypeRequiredDescription
KBCategoriesformList<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: baseservices2.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">
  <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">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <KBCategories xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.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>