GET openapi/categories/roots?maxDepth={maxDepth}

Authorization

Access to this endpoint is public.

Request Information

URI Parameters

Name	Description	Type	Additional information
maxDepth		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": "75241584-4d77-4834-8946-c878b03eb102",
  "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": "58cb9182-acd0-4915-a82d-7b169f9d4cfb",
      "Type": "sample string 2",
      "Sequence": 1,
      "Description": "sample string 3",
      "Duration": 1,
      "StudentCompletionDuration": 1,
      "Url": "sample string 4",
      "IsSkippable": true
    },
    {
      "Id": "58cb9182-acd0-4915-a82d-7b169f9d4cfb",
      "Type": "sample string 2",
      "Sequence": 1,
      "Description": "sample string 3",
      "Duration": 1,
      "StudentCompletionDuration": 1,
      "Url": "sample string 4",
      "IsSkippable": true
    }
  ]
}