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 .jsv suffix or ?format=jsv

HTTP + JSV

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

{
	CategoryId: 0,
	SearchText: String,
	start: 2020-07-03T23:11:04.5938073+03:00
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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: 0001-01-01,
					Edited: 0001-01-01,
					IsDraft: 0,
					PublishStartDate: 0001-01-01,
					PublishEndDate: 0001-01-01,
					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: 0001-01-01,
							Edited: 0001-01-01,
							IsDraft: 0,
							PublishStartDate: 0001-01-01,
							PublishEndDate: 0001-01-01,
							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: 0001-01-01,
									Edited: 0001-01-01,
									IsDraft: 0,
									PublishStartDate: 0001-01-01,
									PublishEndDate: 0001-01-01,
									Author: 0,
									CategoryId: 0,
									SefName: String,
									NeedionName: String
								}
							]
						}
					]
				}
			]
		}
	],
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	}
}