GET categories/{categoryId}
Get category by id. User Authorization Optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
categoryId |
the category id |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
a category
ResponseInstanceOfCategoryName | Description | Type | Additional information |
---|---|---|---|
Data | Category |
None. |
|
ResultType | ResultType |
None. |
|
Messages | Collection of string |
None. |
|
Links | Links |
None. |
|
ApiBaseUrl | string |
None. |
|
responseObjectType | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "data": { "categoryId": 1, "categoryName": "sample string 2", "seoName": "sample string 3", "questions": 4, "sortOrder": 5, "apiUrl": { "href": "/categories/sample string 8" }, "resourceObjectType": "category" }, "resultType": { "code": 0, "message": "Success" }, "messages": [ "sample string 1", "sample string 2" ], "links": {}, "apiBaseUrl": "sample string 1", "responseObjectType": "responseInstance<category>" }
application/xml, text/xml
Sample:
<ResponseInstance xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ApiBaseUrl>sample string 1</ApiBaseUrl> <Links> <First i:nil="true" /> <Last i:nil="true" /> <Next i:nil="true" /> <Previous i:nil="true" /> <Self i:nil="true" /> </Links> <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Messages> <ResultType> <Code>Success</Code> <Message>Success</Message> </ResultType> <responseObjectType>responseInstance<category></responseObjectType> <Data> <ApiUrl> <href>/categories/sample string 8</href> </ApiUrl> <ResourceObjectType>category</ResourceObjectType> <CategoryGroup i:nil="true" /> <CategoryId>1</CategoryId> <CategoryName>sample string 2</CategoryName> <Questions>4</Questions> <SeoName>sample string 3</SeoName> <SortOrder>5</SortOrder> </Data> </ResponseInstance>