GET categories/{id}/children?SortBy={SortBy}&Direction={Direction}

Gets all children 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

NameDescriptionTypeAdditional information
id

id of parent category

globally unique identifier

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

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "e2721aaf-4a83-443c-8eea-52c7dcbfcfa5",
    "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": "e2721aaf-4a83-443c-8eea-52c7dcbfcfa5",
    "Type": "sample string 2",
    "Sequence": 1,
    "Path": "sample string 3",
    "Attributes": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "ChildCategories": []
  }
]