Contents
Schema #
The schema defines all the fields that exist within a sfwd topic 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: |
menu_order integer |
The order of the object in relation to other object of its type. Context: |
template string |
The theme file to use to display the object. Context: |
ld_topic_category array |
The terms assigned to the object in the ld_topic_category taxonomy. Context: |
ld_topic_tag array |
The terms assigned to the object in the ld_topic_tag taxonomy. Context: |
topic_materials html |
Topic Materials Context: |
forced_lesson_time text |
Forced Topic Timer Context: |
lesson_assignment_upload boolean |
Upload Assignment Context: |
auto_approve_assignment boolean |
Auto Approve Assignment Context: |
assignment_upload_limit_count number |
Limit number of uploaded files Context: |
lesson_assignment_points_enabled boolean |
Award Points for Assignment Context: |
lesson_assignment_points_amount number |
Set Number of Points for Assignment Context: |
assignment_upload_limit_extensions text |
Allowed File Extensions Context: |
assignment_upload_limit_size text |
Allowed File Size Context: |
List Sfwd Topics #
Query this endpoint to retrieve a collection of sfwd topics. The response you receive can be controlled and filtered using the URL query parameters below.
Definition #
GET /ldlms/v1/sfwd-topic
Example Request #
$ curl https://example.com/wp-json/ldlms/v1/sfwd-topic
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. |
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: 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: |
ld_topic_category |
Limit result set to all items that have the specified term assigned in the ld_topic_category taxonomy. |
ld_topic_category_exclude |
Limit result set to all items except those that have the specified term assigned in the ld_topic_category taxonomy. |
ld_topic_tag |
Limit result set to all items that have the specified term assigned in the ld_topic_tag taxonomy. |
ld_topic_tag_exclude |
Limit result set to all items except those that have the specified term assigned in the ld_topic_tag taxonomy. |
course |
Limit results to be within a specific Course. Required for non-admin users. |
lesson |
Limit results to be within a specific Lesson. Must be used with course parameter. |
Create a Sfwd Topic #
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. |
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. |
ld_topic_category |
The terms assigned to the object in the ld_topic_category taxonomy. |
ld_topic_tag |
The terms assigned to the object in the ld_topic_tag taxonomy. |
topic_materials |
Topic Materials |
forced_lesson_time |
Forced Topic Timer |
lesson_assignment_upload |
Upload Assignment |
auto_approve_assignment |
Auto Approve Assignment
Default: |
assignment_upload_limit_count |
Limit number of uploaded files
Default: |
lesson_assignment_points_enabled |
Award Points for Assignment |
lesson_assignment_points_amount |
Set Number of Points for Assignment |
assignment_upload_limit_extensions |
Allowed File Extensions |
assignment_upload_limit_size |
Allowed File Size |
Definition #
POST /ldlms/v1/sfwd-topic
Retrieve a Sfwd Topic #
Definition & Example Request #
GET /ldlms/v1/sfwd-topic/<id>
Query this endpoint to retrieve a specific sfwd topic record.
$ curl https://example.com/wp-json/ldlms/v1/sfwd-topic/<id>
Sample Response #
{ "id": 80104, "date": "2018-10-02T16:29:11", "date_gmt": "2018-10-02T23:29:11", "guid": { "rendered": "https://example.com/?post_type=sfwd-topic&p=80104" }, "modified": "2018-10-02T16:29:11", "modified_gmt": "2018-10-02T23:29:11", "slug": "pd-review-week-23", "status": "publish", "type": "sfwd-topic", "link": "http://example.com/topic/pd-review-week-23/", "title": { "rendered": "PD • Review • Week 23" }, "content": { "rendered": "", "protected": false }, "author": 12, "featured_media": 0, "menu_order": 0, "template": "", "ld_topic_category": [], "ld_topic_tag": [], "topic_materials": "", "forced_lesson_time": "", "lesson_assignment_upload": "", "auto_approve_assignment": "", "assignment_upload_limit_count": "", "lesson_assignment_points_enabled": "", "lesson_assignment_points_amount": "", "assignment_upload_limit_extensions": "", "assignment_upload_limit_size": "", "_links": { "self": [ { "href": "http://example.com/wp-json/ldlms/v1/sfwd-topic/80104" } ], "collection": [ { "href": "http://example.com/wp-json/ldlms/v1/sfwd-topic" } ], "about": [ { "href": "http://example.com/wp-json/wp/v2/types/sfwd-topic" } ], "author": [ { "embeddable": true, "href": "http://example.com/wp-json/wp/v2/users/12" } ], "version-history": [ { "count": 0, "href": "http://example.com/wp-json/ldlms/v1/sfwd-topic/80104/revisions" } ], "wp:attachment": [ { "href": "http://example.com/wp-json/wp/v2/media?parent=80104" } ], "wp:term": [ { "taxonomy": "ld_topic_category", "embeddable": true, "href": "http://example.com/wp-json/wp/v2/ld_topic_category?post=80104" }, { "taxonomy": "ld_topic_tag", "embeddable": true, "href": "http://example.com/wp-json/wp/v2/ld_topic_tag?post=80104" } ], "curies": [ { "name": "wp", "href": "https://api.w.org/{rel}", "templated": true } ] } }
Arguments #
id |
Unique identifier for the object. |
context |
Scope under which the request is made; determines fields present in response.
Default: One of: |
password |
The password for the post if it is password protected. |
Update a Sfwd Topic #
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: |
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. |
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. |
ld_topic_category |
The terms assigned to the object in the ld_topic_category taxonomy. |
ld_topic_tag |
The terms assigned to the object in the ld_topic_tag taxonomy. |
topic_materials |
Topic Materials |
forced_lesson_time |
Forced Topic Timer |
lesson_assignment_upload |
Upload Assignment |
auto_approve_assignment |
Auto Approve Assignment |
assignment_upload_limit_count |
Limit number of uploaded files |
lesson_assignment_points_enabled |
Award Points for Assignment |
lesson_assignment_points_amount |
Set Number of Points for Assignment |
assignment_upload_limit_extensions |
Allowed File Extensions |
assignment_upload_limit_size |
Allowed File Size |