Contents
Schema #
The schema defines all the fields that exist within a lesson record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.
date string, null, datetime (details) |
The date the object was published, in the site's timezone. Context: |
date_gmt string, null, datetime (details) |
The date the object was published, as GMT. Context: |
guid object |
The globally unique identifier for the object. Read only Context: |
id integer |
Unique identifier for the object. Read only Context: |
link string, uri |
URL to the object. Read only Context: |
modified string, datetime (details) |
The date the object was last modified, in the site's timezone. Read only Context: |
modified_gmt string, datetime (details) |
The date the object was last modified, as GMT. Read only Context: |
slug string |
An alphanumeric identifier for the object unique to its type. Context: |
status string |
A named status for the object. Context: One of: |
type string |
Type of Post for the object. Read only Context: |
password string |
A password to protect access to the content and excerpt. Context: |
permalink_template string |
Permalink template for the object. Read only Context: |
generated_slug string |
Slug automatically generated from the object title. Read only Context: |
title object |
The title for the object. Context: |
content object |
The content for the object. Context: |
author integer |
The ID for the author of the object. Context: |
featured_media integer |
The ID of the featured media for the object. Context: |
comment_status string |
Whether or not comments are open on the object. Context: One of: |
ping_status string |
Whether or not the object can be pinged. Context: One of: |
menu_order integer |
The order of the object in relation to other object of its type. Context: |
meta object |
Meta fields. Context: |
template string |
The theme file to use to display the object. Context: |
categories array |
The terms assigned to the object in the category taxonomy. Context: |
tags array |
The terms assigned to the object in the post_tag taxonomy. Context: |
ld_lesson_category array |
The terms assigned to the object in the ld_lesson_category taxonomy. Context: |
ld_lesson_tag array |
The terms assigned to the object in the ld_lesson_tag taxonomy. Context: |
materials_enabled boolean |
Materials Eabled Context: |
materials string |
Materials Context: |
video_enabled boolean |
Lesson Video Progression Eabled Context: |
video_url text |
Lesson Video Progression URL Context: |
video_shown string |
Lesson Video Shown before or after sub-steps Context: One of: |
video_auto_complete boolean |
Lesson Video Auto-complete Context: |
video_auto_complete_delay integer |
Lesson Video Completion Delay (seconds). Context: |
video_show_complete_button boolean |
Lesson Video Show Mark Complete Button Context: |
video_auto_start boolean |
Lesson Video Autostart Context: |
video_show_controls boolean |
Lesson Video Controls Display. YouTube and local videos only Context: |
video_focus_pause boolean |
Video Pause on Window Unfocused Context: |
video_resume boolean |
Video Resume Context: |
assignment_upload_enabled boolean |
Lesson Assignment Uploads Enabled Context: |
assignment_points_enabled boolean |
Lesson Assignment Points Enabled Context: |
assignment_points_amount integer |
Lesson Assignment Points Amount Context: |
assignment_auto_approve boolean |
Lesson Assignment Auto-approve Enabled Context: |
assignment_deletion_enabled boolean |
Lesson Assignment Allow File Deletion. Context: |
forced_timer_enabled boolean |
Lesson Time Enabled Context: |
forced_timer_amount integer |
Lesson Timer Amount. Context: |
course integer |
Associated Course Context: |
is_sample boolean |
Sample Lesson Context: |
visible_type string |
Available Release Schedule Context: One of: |
assignment_upload_limit_extensions text |
Lesson Assignment Allowed file extensions. Comma separated pdf, xls, zip Context: |
assignment_upload_limit_size text |
Lesson Assignment Upload size limit. Max per server is 32M Context: |
assignment_upload_limit_count integer |
Lesson Assignment Upload Count Limit. Context: |
visible_after integer |
Visible After X day(s) Context: |
visible_after_specific_date date |
Visible After Specific Date (YYYY-MM-DD) Context: |
List Lessons #
Query this endpoint to retrieve a collection of lessons. The response you receive can be controlled and filtered using the URL query parameters below.
Definition #
GET /ldlms/v2/sfwd-lessons
Example Request #
$ curl https://example.com/wp-json/ldlms/v2/sfwd-lessons
Arguments #
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
after |
Limit response to posts published after a given ISO8601 compliant date. |
modified_after |
Limit response to posts modified after a given ISO8601 compliant date. |
author |
Limit result set to posts assigned to specific authors. |
author_exclude |
Ensure result set excludes posts assigned to specific authors. |
before |
Limit response to posts published before a given ISO8601 compliant date. |
modified_before |
Limit response to posts modified before a given ISO8601 compliant date. |
exclude |
Ensure result set excludes specific IDs. |
include |
Limit result set to specific IDs. |
menu_order |
Limit result set to posts with a specific menu_order value. |
offset |
Offset the result set by a specific number of items. |
order |
Order sort attribute ascending or descending.
Default: One of: |
orderby |
Sort collection by object attribute.
Default: One of: |
slug |
Limit result set to posts with one or more specific slugs. |
status |
Limit result set to posts assigned one or more statuses.
Default: |
tax_relation |
Limit result set based on relationship between multiple taxonomies. One of: |
categories |
Limit result set to items with specific terms assigned in the categories taxonomy. |
categories_exclude |
Limit result set to items except those with specific terms assigned in the categories taxonomy. |
tags |
Limit result set to items with specific terms assigned in the tags taxonomy. |
tags_exclude |
Limit result set to items except those with specific terms assigned in the tags taxonomy. |
ld_lesson_category |
Limit result set to items with specific terms assigned in the ld_lesson_category taxonomy. |
ld_lesson_category_exclude |
Limit result set to items except those with specific terms assigned in the ld_lesson_category taxonomy. |
ld_lesson_tag |
Limit result set to items with specific terms assigned in the ld_lesson_tag taxonomy. |
ld_lesson_tag_exclude |
Limit result set to items except those with specific terms assigned in the ld_lesson_tag taxonomy. |
course |
Limit results to be within a specific Course. Required for non-admin users. |
Create a Lesson #
Arguments #
date |
The date the object was published, in the site's timezone. |
date_gmt |
The date the object was published, as GMT. |
slug |
An alphanumeric identifier for the object unique to its type. |
status |
A named status for the object. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the object. |
content |
The content for the object. |
author |
The ID for the author of the object. |
featured_media |
The ID of the featured media for the object. |
comment_status |
Whether or not comments are open on the object. One of: |
ping_status |
Whether or not the object can be pinged. One of: |
menu_order |
The order of the object in relation to other object of its type. |
meta |
Meta fields. |
template |
The theme file to use to display the object. |
categories |
The terms assigned to the object in the category taxonomy. |
tags |
The terms assigned to the object in the post_tag taxonomy. |
ld_lesson_category |
The terms assigned to the object in the ld_lesson_category taxonomy. |
ld_lesson_tag |
The terms assigned to the object in the ld_lesson_tag taxonomy. |
materials_enabled |
Materials Eabled |
materials |
Materials |
video_enabled |
Lesson Video Progression Eabled |
video_url |
Lesson Video Progression URL |
video_shown |
Lesson Video Shown before or after sub-steps
Default: One of: |
video_auto_complete |
Lesson Video Auto-complete |
video_auto_complete_delay |
Lesson Video Completion Delay (seconds). |
video_show_complete_button |
Lesson Video Show Mark Complete Button |
video_auto_start |
Lesson Video Autostart |
video_show_controls |
Lesson Video Controls Display. YouTube and local videos only |
video_focus_pause |
Video Pause on Window Unfocused |
video_resume |
Video Resume |
assignment_upload_enabled |
Lesson Assignment Uploads Enabled |
assignment_upload_limit_extensions |
Lesson Assignment Allowed file extensions. Comma separated pdf, xls, zip |
assignment_upload_limit_size |
Lesson Assignment Upload size limit. Max per server is 32M |
assignment_points_enabled |
Lesson Assignment Points Enabled |
assignment_points_amount |
Lesson Assignment Points Amount |
assignment_auto_approve |
Lesson Assignment Auto-approve Enabled
Default: |
assignment_upload_limit_count |
Lesson Assignment Upload Count Limit. |
assignment_deletion_enabled |
Lesson Assignment Allow File Deletion. |
forced_timer_enabled |
Lesson Time Enabled |
forced_timer_amount |
Lesson Timer Amount. |
course |
Associated Course |
is_sample |
Sample Lesson |
visible_type |
Available Release Schedule One of: |
visible_after |
Visible After X day(s) |
visible_after_specific_date |
Visible After Specific Date (YYYY-MM-DD) |
Definition #
POST /ldlms/v2/sfwd-lessons
List Lessons #
Query this endpoint to retrieve a collection of lessons. The response you receive can be controlled and filtered using the URL query parameters below.
Definition #
GET /ldlms/v2/sfwd-lessons/<id>
Example Request #
$ curl https://example.com/wp-json/ldlms/v2/sfwd-lessons/<id>
Arguments #
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
page |
Current page of the collection.
Default: |
per_page |
Maximum number of items to be returned in result set.
Default: |
search |
Limit results to those matching a string. |
after |
Limit response to posts published after a given ISO8601 compliant date. |
modified_after |
Limit response to posts modified after a given ISO8601 compliant date. |
author |
Limit result set to posts assigned to specific authors. |
author_exclude |
Ensure result set excludes posts assigned to specific authors. |
before |
Limit response to posts published before a given ISO8601 compliant date. |
modified_before |
Limit response to posts modified before a given ISO8601 compliant date. |
exclude |
Ensure result set excludes specific IDs. |
include |
Limit result set to specific IDs. |
menu_order |
Limit result set to posts with a specific menu_order value. |
offset |
Offset the result set by a specific number of items. |
order |
Order sort attribute ascending or descending.
Default: One of: |
orderby |
Sort collection by object attribute.
Default: One of: |
slug |
Limit result set to posts with one or more specific slugs. |
status |
Limit result set to posts assigned one or more statuses.
Default: |
tax_relation |
Limit result set based on relationship between multiple taxonomies. One of: |
categories |
Limit result set to items with specific terms assigned in the categories taxonomy. |
categories_exclude |
Limit result set to items except those with specific terms assigned in the categories taxonomy. |
tags |
Limit result set to items with specific terms assigned in the tags taxonomy. |
tags_exclude |
Limit result set to items except those with specific terms assigned in the tags taxonomy. |
ld_lesson_category |
Limit result set to items with specific terms assigned in the ld_lesson_category taxonomy. |
ld_lesson_category_exclude |
Limit result set to items except those with specific terms assigned in the ld_lesson_category taxonomy. |
ld_lesson_tag |
Limit result set to items with specific terms assigned in the ld_lesson_tag taxonomy. |
ld_lesson_tag_exclude |
Limit result set to items except those with specific terms assigned in the ld_lesson_tag taxonomy. |
course |
Limit results to be within a specific Course. Required for non-admin users. |
Update a Lesson #
Arguments #
date |
The date the object was published, in the site's timezone. |
date_gmt |
The date the object was published, as GMT. |
slug |
An alphanumeric identifier for the object unique to its type. |
status |
A named status for the object. One of: |
password |
A password to protect access to the content and excerpt. |
title |
The title for the object. |
content |
The content for the object. |
author |
The ID for the author of the object. |
featured_media |
The ID of the featured media for the object. |
comment_status |
Whether or not comments are open on the object. One of: |
ping_status |
Whether or not the object can be pinged. One of: |
menu_order |
The order of the object in relation to other object of its type. |
meta |
Meta fields. |
template |
The theme file to use to display the object. |
categories |
The terms assigned to the object in the category taxonomy. |
tags |
The terms assigned to the object in the post_tag taxonomy. |
ld_lesson_category |
The terms assigned to the object in the ld_lesson_category taxonomy. |
ld_lesson_tag |
The terms assigned to the object in the ld_lesson_tag taxonomy. |
materials_enabled |
Materials Eabled |
materials |
Materials |
video_enabled |
Lesson Video Progression Eabled |
video_url |
Lesson Video Progression URL |
video_shown |
Lesson Video Shown before or after sub-steps One of: |
video_auto_complete |
Lesson Video Auto-complete |
video_auto_complete_delay |
Lesson Video Completion Delay (seconds). |
video_show_complete_button |
Lesson Video Show Mark Complete Button |
video_auto_start |
Lesson Video Autostart |
video_show_controls |
Lesson Video Controls Display. YouTube and local videos only |
video_focus_pause |
Video Pause on Window Unfocused |
video_resume |
Video Resume |
assignment_upload_enabled |
Lesson Assignment Uploads Enabled |
assignment_upload_limit_extensions |
Lesson Assignment Allowed file extensions. Comma separated pdf, xls, zip |
assignment_upload_limit_size |
Lesson Assignment Upload size limit. Max per server is 32M |
assignment_points_enabled |
Lesson Assignment Points Enabled |
assignment_points_amount |
Lesson Assignment Points Amount |
assignment_auto_approve |
Lesson Assignment Auto-approve Enabled |
assignment_upload_limit_count |
Lesson Assignment Upload Count Limit. |
assignment_deletion_enabled |
Lesson Assignment Allow File Deletion. |
forced_timer_enabled |
Lesson Time Enabled |
forced_timer_amount |
Lesson Timer Amount. |
course |
Associated Course |
is_sample |
Sample Lesson |
visible_type |
Available Release Schedule One of: |
visible_after |
Visible After X day(s) |
visible_after_specific_date |
Visible After Specific Date (YYYY-MM-DD) |