GET categories/{id}

Gets category by id.

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 category

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

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": "02eb70c9-9e9c-41b8-b143-fd87bc8568db",
  "Type": "sample string 2",
  "Sequence": 1,
  "Path": "sample string 3",
  "Attributes": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "ChildCategories": []
}