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

NameDescriptionTypeAdditional information
categoryId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Core.Models.CategoryWithContentItems
NameDescriptionTypeAdditional 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": "47dd81bd-beb4-47f9-a5ab-30ace86a514d",
  "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": "c00f0d7a-d8c6-4726-881c-a3b450b731e4",
      "Type": "sample string 2",
      "Sequence": 1,
      "Description": "sample string 3",
      "Duration": 1,
      "StudentCompletionDuration": 1,
      "Url": "sample string 4",
      "IsSkippable": true
    },
    {
      "Id": "c00f0d7a-d8c6-4726-881c-a3b450b731e4",
      "Type": "sample string 2",
      "Sequence": 1,
      "Description": "sample string 3",
      "Duration": 1,
      "StudentCompletionDuration": 1,
      "Url": "sample string 4",
      "IsSkippable": true
    }
  ]
}