GET students/{userIdentifier}/courseCategories/roots?maxDepth={maxDepth}

Gets descendant categories of roots up to given depth available to student.

Authorization

Access to this endpoint is granted if all following conditions are true:

Authenticated user is a staff member and is assigned to the same center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter.
Authenticated user who is either StaffMember

Request Information

URI Parameters

Name	Description	Type	Additional information
userIdentifier	User identifier.	PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier	Required
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": "5892a9d2-7269-4a32-a02c-3c6402ed2c3d",
  "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": "a40ae614-a3fc-4786-a0f4-f8f7309e5c4c",
      "Type": "sample string 2",
      "Sequence": 1,
      "Description": "sample string 3",
      "Duration": 1,
      "StudentCompletionDuration": 1,
      "Url": "sample string 4",
      "IsSkippable": true
    },
    {
      "Id": "a40ae614-a3fc-4786-a0f4-f8f7309e5c4c",
      "Type": "sample string 2",
      "Sequence": 1,
      "Description": "sample string 3",
      "Duration": 1,
      "StudentCompletionDuration": 1,
      "Url": "sample string 4",
      "IsSkippable": true
    }
  ]
}