Lessons

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: view, edit, embed

date_gmt
string, null, datetime (details)

The date the object was published, as GMT.

Context: view, edit

guid
object

The globally unique identifier for the object.

Read only

Context: view, edit

id
integer

Unique identifier for the object.

Read only

Context: view, edit, embed

modified
string, datetime (details)

The date the object was last modified, in the site's timezone.

Read only

Context: view, edit

modified_gmt
string, datetime (details)

The date the object was last modified, as GMT.

Read only

Context: view, edit

slug
string

An alphanumeric identifier for the object unique to its type.

Context: view, edit, embed

status
string

A named status for the object.

Context: view, edit

One of: publish, future, draft, pending, private, graded, not_graded

type
string

Type of Post for the object.

Read only

Context: view, edit, embed

password
string

A password to protect access to the content and excerpt.

Context: edit

generated_slug
string

Slug automatically generated from the object title.

Read only

Context: edit

title
object

The title for the object.

Context: view, edit, embed

content
object

The content for the object.

Context: view, edit

author
integer

The ID for the author of the object.

Context: view, edit, embed

comment_status
string

Whether or not comments are open on the object.

Context: view, edit

One of: open, closed

ping_status
string

Whether or not the object can be pinged.

Context: view, edit

One of: open, closed

menu_order
integer

The order of the object in relation to other object of its type.

Context: view, edit

template
string

The theme file to use to display the object.

Context: view, edit

categories
array

The terms assigned to the object in the category taxonomy.

Context: view, edit

tags
array

The terms assigned to the object in the post_tag taxonomy.

Context: view, edit

ld_lesson_category
array

The terms assigned to the object in the ld_lesson_category taxonomy.

Context: view, edit

ld_lesson_tag
array

The terms assigned to the object in the ld_lesson_tag taxonomy.

Context: view, edit

materials_enabled
boolean

Materials Eabled

Context: view, edit

materials
string

Materials

Context: view, edit

video_enabled
boolean

Lesson Video Progression Eabled

Context: view, edit

video_url
text

Lesson Video Progression URL

Context: view, edit

video_shown
string

Lesson Video Shown before or after sub-steps

Context: view, edit

One of: BEFORE, AFTER

video_auto_complete
boolean

Lesson Video Auto-complete

Context: view, edit

lesson_video_auto_complete_delay
integer

Lesson Video Completion Delay (seconds).

Context: view, edit

video_show_complete_button
boolean

Lesson Video Show Mark Complete Button

Context: view, edit

video_auto_start
boolean

Lesson Video Autostart

Context: view, edit

video_show_controls
boolean

Lesson Video Controls Display. YouTube and local videos only

Context: view, edit

assignment_upload_enabled
boolean

Lesson Assignment Uploads Enabled

Context: view, edit

assignment_upload_limit_extensions
text

Lesson Assignment Allowed file extensions. Comma separated pdf, xls, zip

Context: view, edit

assignment_upload_limit_size
text

Lesson Assignment Upload size limit. Max per server is 32M

Context: view, edit

assignment_points_enabled
boolean

Lesson Assignment Points Enabled

Context: view, edit

assignment_points_amount
integer

Lesson Assignment Points Amount

Context: view, edit

assignment_auto_approve
boolean

Lesson Assignment Auto-approve Enabled

Context: view, edit

assignment_upload_limit_count
integer

Lesson Assignment Upload Count Limit.

Context: view, edit

assignment_deletion_enabled
boolean

Lesson Assignment Allow File Deletion.

Context: view, edit

forced_timer_enabled
boolean

Lesson Time Enabled

Context: view, edit

forced_timer_amount
text

Lesson Timer Amount.

Context: view, edit

course
integer

Associated Course

Context: view, edit

is_sample
boolean

Sample Lesson

Context: view, edit

visible_type
string

Available Release Schedule

Context: view, edit

One of: , visible_after, visible_after_specific_date

visible_after
integer

Visible After X day(s)

Context: view, edit

visible_after_specific_date
date

Visible After Specific Date (YYYY-MM-DD)

Context: view, edit

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: view

One of: view, embed, edit

page

Current page of the collection.

Default: 1

per_page

Maximum number of items to be returned in result set.

Default: 10

search

Limit results to those matching a string.

after

Limit response to posts published 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.

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: asc

One of: asc, desc

orderby

Sort collection by object attribute.

Default: title

One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title, menu_order

slug

Limit result set to posts with one or more specific slugs.

status

Limit result set to posts assigned one or more statuses.

Default: publish

tax_relation

Limit result set based on relationship between multiple taxonomies.

One of: AND, OR

categories

Limit result set to all items that have the specified term assigned in the categories taxonomy.

categories_exclude

Limit result set to all items except those that have the specified term assigned in the categories taxonomy.

tags

Limit result set to all items that have the specified term assigned in the tags taxonomy.

tags_exclude

Limit result set to all items except those that have the specified term assigned in the tags taxonomy.

ld_lesson_category

Limit result set to all items that have the specified term assigned in the ld_lesson_category taxonomy.

ld_lesson_category_exclude

Limit result set to all items except those that have the specified term assigned in the ld_lesson_category taxonomy.

ld_lesson_tag

Limit result set to all items that have the specified term assigned in the ld_lesson_tag taxonomy.

ld_lesson_tag_exclude

Limit result set to all items except those that have the specified term 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: publish, future, draft, pending, private, graded, not_graded

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: open, closed

ping_status

Whether or not the object can be pinged.

One of: open, closed

menu_order

The order of the object in relation to other object of its type.

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: BEFORE

One of: BEFORE, AFTER

video_auto_complete

Lesson Video Auto-complete

lesson_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

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: 1

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_specific_date

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 #

id

Unique identifier for the object.

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view, embed, edit

page

Current page of the collection.

Default: 1

per_page

Maximum number of items to be returned in result set.

Default: 10

search

Limit results to those matching a string.

after

Limit response to posts published 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.

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: asc

One of: asc, desc

orderby

Sort collection by object attribute.

Default: title

One of: author, date, id, include, modified, parent, relevance, slug, include_slugs, title, menu_order

slug

Limit result set to posts with one or more specific slugs.

status

Limit result set to posts assigned one or more statuses.

Default: publish

tax_relation

Limit result set based on relationship between multiple taxonomies.

One of: AND, OR

categories

Limit result set to all items that have the specified term assigned in the categories taxonomy.

categories_exclude

Limit result set to all items except those that have the specified term assigned in the categories taxonomy.

tags

Limit result set to all items that have the specified term assigned in the tags taxonomy.

tags_exclude

Limit result set to all items except those that have the specified term assigned in the tags taxonomy.

ld_lesson_category

Limit result set to all items that have the specified term assigned in the ld_lesson_category taxonomy.

ld_lesson_category_exclude

Limit result set to all items except those that have the specified term assigned in the ld_lesson_category taxonomy.

ld_lesson_tag

Limit result set to all items that have the specified term assigned in the ld_lesson_tag taxonomy.

ld_lesson_tag_exclude

Limit result set to all items except those that have the specified term 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 #

id

Unique identifier for the object.

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: publish, future, draft, pending, private, graded, not_graded

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: open, closed

ping_status

Whether or not the object can be pinged.

One of: open, closed

menu_order

The order of the object in relation to other object of its type.

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: BEFORE, AFTER

video_auto_complete

Lesson Video Auto-complete

lesson_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

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_specific_date

visible_after

Visible After X day(s)

visible_after_specific_date

Visible After Specific Date (YYYY-MM-DD)

Definition #

POST /ldlms/v2/sfwd-lessons/<id>

Example Request #

Delete a Lesson #

Arguments #

id

Unique identifier for the object.

force

Whether to bypass trash and force deletion.

Definition #

DELETE /ldlms/v2/sfwd-lessons/<id>

Example Request #

$ curl -X DELETE https://example.com/wp-json/ldlms/v2/sfwd-lessons/<id>