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
DeviceUUIDformstringNo
GetKbCategoriesResponse Parameters:
NameParameterData TypeRequiredDescription
KBCategoriesformList<KbCategoryDTO>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"CategoryId":0,"SearchText":"String","start":"\/Date(1600787877388+0300)\/","DeviceUUID":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"KBCategories":[{"CategoryId":0,"Name":"String","IsHot":false,"Parent":0,"SefName":"String","Author":0,"Icon":"String","Articles":[{"ArticleId":0,"Title":"String","Content":"String","Views":0,"Likes":0,"Created":"\/Date(-62135596800000-0000)\/","Edited":"\/Date(-62135596800000-0000)\/","IsDraft":0,"PublishStartDate":"\/Date(-62135596800000-0000)\/","PublishEndDate":"\/Date(-62135596800000-0000)\/","Author":0,"CategoryId":0,"SefName":"String","NeedionName":"String"}],"SubCategories":[{"CategoryId":0,"Name":"String","IsHot":false,"Parent":0,"SefName":"String","Author":0,"Icon":"String","Articles":[{"ArticleId":0,"Title":"String","Content":"String","Views":0,"Likes":0,"Created":"\/Date(-62135596800000-0000)\/","Edited":"\/Date(-62135596800000-0000)\/","IsDraft":0,"PublishStartDate":"\/Date(-62135596800000-0000)\/","PublishEndDate":"\/Date(-62135596800000-0000)\/","Author":0,"CategoryId":0,"SefName":"String","NeedionName":"String"}],"SubCategories":[{"CategoryId":0,"Name":"String","IsHot":false,"Parent":0,"SefName":"String","Author":0,"Icon":"String","Articles":[{"ArticleId":0,"Title":"String","Content":"String","Views":0,"Likes":0,"Created":"\/Date(-62135596800000-0000)\/","Edited":"\/Date(-62135596800000-0000)\/","IsDraft":0,"PublishStartDate":"\/Date(-62135596800000-0000)\/","PublishEndDate":"\/Date(-62135596800000-0000)\/","Author":0,"CategoryId":0,"SefName":"String","NeedionName":"String"}]}]}]}],"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}