Create/Update page
| Method |
Description |
| course.pageCreate |
Create learning page. |
| course.pageUpdate |
Update learning page. |
Request parameters
{
"page": {
"id": {PageId}, /* Only for update operation */
"course_id": {CourseId},
"name": "{PageName}",
"description": "{PageDescription}",
"external_id": "{ExternalId}"
},
"resources": {
"{ResourcePath}": "{ResourceCnt}",
...
}
}
Response parameters
{
"page": {
"id": {PageId},
"course_id": {CourseId},
"name": "{PageName}",
"description": "{PageDescription}",
"external_id": "{ExternalId}",
"time_to_read": {TimeToRead},
"order": {Order}
},
"resources": {
"{ResourcePath}": "{NewResourcePath}",
...
},
"completed": {Comleted}
}
Parameters meaning
| Variable |
Type |
Appearance |
Description |
| {PageId} |
Integer |
Mandatory |
Page id. Mandatory for update operation. |
| {CourseId} |
Integer |
Mandatory |
Course id. |
| {PageName} |
String |
Mandatory |
Learning page name; shown in the course table of contents and used as a heading when the page content is displayed. |
| {PageDescription} |
String |
Mandatory |
Learning page content. HTML formatted, may contain media resources like images and audio. Please be aware that only relative URLs are allowed. See Rich HTML formatting for the full list of supported tags and attributes. |
| {ExternalId} |
String |
Optional |
External Id. Optional field to store external system page id, which later can be used for matching/synchronization. |
| {TimeToRead} |
Integer |
Mandatory |
Estimated time to read the page, in minutes. Calculated automatically from the page content. |
| {Order} |
Integer |
Mandatory |
Display order of the page within the course. |
| resources |
| resources |
Object |
Optional |
If you are using media resources like images you need to send the content of each media resource under "resources" node. |
| {ResourcePath} |
String |
Mandatory |
Path of media resource. Same value as it was used in Description. Example: "image.jpg" for <img src="image.jpg">. |
| {ResourceCnt} |
String |
Mandatory |
Base64 encoded content of media resource. |
| {NewResourcePath} |
String |
Mandatory |
New media resource path. |
| response |
| {Completed} |
Boolean |
Mandatory |
Indicates whether action was successfully completed or not. |