GET contentItems/{id}?includeHierarchy={includeHierarchy}
Gets a content item and (optionaly) its hierarchy.
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 a Content Item to retrieve. |
globally unique identifier |
Required |
includeHierarchy |
Option to include the hierarchy data. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Content Item
PearsonEnglish.LearningServices.Core.Models.Views.ContentItemViewModelName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Description | string |
None. |
|
Duration | integer |
None. |
|
IsSkippable | boolean |
None. |
|
Url | string |
None. |
|
CourseId | globally unique identifier |
None. |
|
Sequence | integer |
None. |
|
AncestorCategoryId | globally unique identifier |
None. |
|
TypeId | integer |
None. |
|
TypeName | string |
None. |
|
Hierarchy | Collection of PearsonEnglish.LearningServices.Core.Models.Views.CategoryViewModel |
None. |
|
ContentOptimizationLevelId | integer |
None. |
|
ContentOptimizationLevelName | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "bbdf0d38-dca1-4712-8a5a-888261309fcc", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "7b664dbc-2c35-45e1-a7c0-63b3a9df83aa", "Sequence": 1, "AncestorCategoryId": "d2b5d6cf-b5d9-4145-a65b-234b60cdf53a", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "ec024d20-efdd-4b8f-9744-2b5da64b9d27", "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": "ec024d20-efdd-4b8f-9744-2b5da64b9d27", "Type": "sample string 2", "Sequence": 1, "Path": "sample string 3", "Attributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "ChildCategories": [] } ], "ContentOptimizationLevelId": 7, "ContentOptimizationLevelName": "sample string 8" }