GET api/WebCategories?parentCategoryId={parentCategoryId}&portalId={portalId}
Retrieve active Web Category, including child categories, determined by user authentication status
Possible Service Responses:
200/OK - match found and list of web category records are in the body of the response.
404/Web Categories Not Found - no match found
500/Internal Server - unexpected server error, details in the body of the response.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| parentCategoryId |
The id of the category. |
System.String |
Required |
| portalId |
The portal ID of the contact to authenticate against. Prevents unauthenticated users from seeing certain categories. |
System.String |
Required |
Body Parameters
None.
Response Information
Resource Description
List of Web Categories
Altai.Web.Services.Models.WebCategory| Name | Description | Type | Additional information |
|---|---|---|---|
| EnableQuantity | System.Boolean |
None. |
|
| Id | System.String |
None. |
|
| Name | System.String |
None. |
|
| WebHeaderText | System.String |
None. |
|
| ImageUrl | System.String |
None. |
|
| IsRestricted | System.Boolean |
None. |
|
| IsTopLevel | System.Boolean |
None. |
|
| IsDefault | System.Boolean |
None. |
|
| IsSelectionRequired | System.Boolean |
None. |
|
| IsAuthenticationRequired | System.Boolean |
None. |
|
| AllowMultipleSelections | System.Boolean |
None. |
|
| DisplayOrder | System.Int32 |
None. |
|
| PageSize | System.Int32 |
None. |
|
| SubCategories | System.Collections.Generic.IEnumerable`1[Altai.Web.Services.Models.WebCategory] |
None. |
|
| Filter | System.String |
None. |
|
| NextWebFormId | System.String |
None. |
|
| NextWebFormName | System.String |
None. |
|
| PreviousWebFormId | System.String |
None. |
|
| PreviousWebFormName | System.String |
None. |
|
| NextCategoryId | System.String |
None. |
|
| PreviousCategoryId | System.String |
None. |
|
| NextNavigation | System.Int32 |
None. |
|
| ItemTemplate | System.Int32 |
None. |
|
| StandAlone | System.Boolean |
None. |
Response Formats
application/json, text/json
{
"EnableQuantity": true,
"Id": "sample string 2",
"Name": "sample string 3",
"WebHeaderText": "sample string 4",
"ImageUrl": "sample string 5",
"IsRestricted": true,
"IsTopLevel": true,
"IsDefault": true,
"IsSelectionRequired": true,
"IsAuthenticationRequired": true,
"AllowMultipleSelections": true,
"DisplayOrder": 12,
"PageSize": 13,
"SubCategories": [],
"Filter": "sample string 14",
"NextWebFormId": "sample string 15",
"NextWebFormName": "sample string 16",
"PreviousWebFormId": "sample string 17",
"PreviousWebFormName": "sample string 18",
"NextCategoryId": "sample string 19",
"PreviousCategoryId": "sample string 20",
"NextNavigation": 21,
"ItemTemplate": 22,
"StandAlone": true
}
application/xml
Sample not available.
text/xml
Sample not available.