GET categories/roots?maxDepth={maxDepth}

Gets descendant categories of roots up to given depth.

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
maxDepth	Max depth.	integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Core.Models.CategoryWithContentItems

Name	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": "8b027b20-7104-415d-b556-257eca51ba33",
  "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": "877f6b96-cb26-427c-8b2d-6e1549b24be6",
      "Type": "sample string 2",
      "Sequence": 1,
      "Description": "sample string 3",
      "Duration": 1,
      "StudentCompletionDuration": 1,
      "Url": "sample string 4",
      "IsSkippable": true
    },
    {
      "Id": "877f6b96-cb26-427c-8b2d-6e1549b24be6",
      "Type": "sample string 2",
      "Sequence": 1,
      "Description": "sample string 3",
      "Duration": 1,
      "StudentCompletionDuration": 1,
      "Url": "sample string 4",
      "IsSkippable": true
    }
  ]
}