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.ContentItemViewModel| Name | 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": "cc9981db-2974-4ef1-b48e-5a2ab82a0636",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f07593cb-0e74-434c-919f-c4b7aede4fb7",
"Sequence": 1,
"AncestorCategoryId": "fc09ede8-74ad-4132-84b9-2b243b81f03d",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "8646eaf4-3ef6-4e4f-b915-a12c9abb9fd6",
"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": "8646eaf4-3ef6-4e4f-b915-a12c9abb9fd6",
"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"
}