GET categories/{categoryId}/descendants
Authorization
Access to this endpoint is granted if all following conditions are true:
- Authenticated user who is either StaffMember
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| categoryId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
PearsonEnglish.LearningServices.Core.Models.CategoryWithContentItems| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Type | string |
None. |
|
| Sequence | integer |
None. |
|
| Path | string |
None. |
|
| Attributes | Dictionary of string [key] and string [value] |
None. |
|
| ChildCategories | Collection of PearsonEnglish.LearningServices.Core.Models.CategoryWithContentItems |
None. |
|
| ContentItems | Collection of PearsonEnglish.LearningServices.Core.Models.ContentItemBase |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "ff8f5a41-b555-4a2b-85b7-7e0708a903be",
"Type": "sample string 2",
"Sequence": 1,
"Path": "sample string 3",
"Attributes": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ChildCategories": [],
"ContentItems": [
{
"Id": "6b13bc85-2537-402b-bdcb-0e9baa60b85d",
"Type": "sample string 2",
"Sequence": 1,
"Description": "sample string 3",
"Duration": 1,
"StudentCompletionDuration": 1,
"Url": "sample string 4",
"IsSkippable": true
},
{
"Id": "6b13bc85-2537-402b-bdcb-0e9baa60b85d",
"Type": "sample string 2",
"Sequence": 1,
"Description": "sample string 3",
"Duration": 1,
"StudentCompletionDuration": 1,
"Url": "sample string 4",
"IsSkippable": true
}
]
}