GET categories/{id}/descendents?depth={depth}&SortBy={SortBy}&Direction={Direction}

Gets all descendants of a specific degree of a given category.

Authorization

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

Authenticated user who is either StaffMember, Student, Administrator, ProspectWithTrial, User

Request Information

URI Parameters

Name	Description	Type	Additional information
id	id of category	globally unique identifier	Required
depth	degree of descendants	integer	Required
SortBy		string	None.
Direction		PearsonEnglish.LearningServices.Core.Models.Enums.Direction	None.

Body Parameters

None.

Response Information

Resource Description

Collection of PearsonEnglish.LearningServices.Core.Models.Views.CategoryViewModel

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.Views.CategoryViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "16a08544-77d1-4b43-bee2-4d53c1b13bd3",
    "Type": "sample string 2",
    "Sequence": 1,
    "Path": "sample string 3",
    "Attributes": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "ChildCategories": []
  },
  {
    "Id": "16a08544-77d1-4b43-bee2-4d53c1b13bd3",
    "Type": "sample string 2",
    "Sequence": 1,
    "Path": "sample string 3",
    "Attributes": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "ChildCategories": []
  }
]