v1/Sfwd Courses – LearnDash Dev Docs

Schema
List Sfwd Courses
Create a Sfwd Course
- Arguments
- Definition
Retrieve a Sfwd Course
Update a Sfwd Course
Delete a Sfwd Course

Schema #

The schema defines all the fields that exist within a sfwd course 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`
`link` string, uri	URL to 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`
`permalink_template` string	Permalink template for the object. Read only 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`
`featured_media` integer	The ID of the featured media for the object. Context: `view`, `edit`, `embed`
`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_course_category` array	The terms assigned to the object in the ld_course_category taxonomy. Context: `view`, `edit`
`ld_course_tag` array	The terms assigned to the object in the ld_course_tag taxonomy. Context: `view`, `edit`
`course_materials` html	Course Materials Context: `view`, `edit`
`course_price_type` string	Course Price Type Context: `view`, `edit` One of: `open`, `closed`, `free`, `buynow`, `subscribe`
`custom_button_label` text	Custom Button Label Context: `view`, `edit`
`custom_button_url` text	Custom Button URL Context: `view`, `edit`
`course_price` text	Course Price Context: `view`, `edit`
`course_prerequisite_enabled` boolean	Enable Course Prerequisites Context: `view`, `edit`
`course_prerequisite` array	Course Prerequisites Context: `view`, `edit`
`course_prerequisite_compare` string	Course Prerequisites Compare Context: `view`, `edit` One of: `ANY`, `ALL`
`course_points_enabled` boolean	Enable Course Points Context: `view`, `edit`
`course_points` number	Course Points Context: `view`, `edit`
`course_points_access` number	Course Points Access Context: `view`, `edit`
`course_disable_lesson_progression` boolean	Disable Lesson Progression Context: `view`, `edit`
`expire_access` boolean	Expire Access Context: `view`, `edit`
`expire_access_days` number	Expire Access After (days) Context: `view`, `edit`
`expire_access_delete_progress` boolean	Delete Course and Quiz Data After Expiration Context: `view`, `edit`

List Sfwd Courses #

Query this endpoint to retrieve a collection of sfwd courses. The response you receive can be controlled and filtered using the URL query parameters below.

Definition #

GET /ldlms/v1/sfwd-courses

Example Request #

$ curl https://example.com/wp-json/ldlms/v1/sfwd-courses

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_course_category`	Limit result set to all items that have the specified term assigned in the ld_course_category taxonomy.
`ld_course_category_exclude`	Limit result set to all items except those that have the specified term assigned in the ld_course_category taxonomy.
`ld_course_tag`	Limit result set to all items that have the specified term assigned in the ld_course_tag taxonomy.
`ld_course_tag_exclude`	Limit result set to all items except those that have the specified term assigned in the ld_course_tag taxonomy.

Create a Sfwd Course #

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.
`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_course_category`	The terms assigned to the object in the ld_course_category taxonomy.
`ld_course_tag`	The terms assigned to the object in the ld_course_tag taxonomy.
`course_materials`	Course Materials
`course_price_type`	Course Price Type Default: `open` One of: `open`, `closed`, `free`, `buynow`, `subscribe`
`custom_button_label`	Custom Button Label
`custom_button_url`	Custom Button URL
`course_price`	Course Price
`course_prerequisite_enabled`	Enable Course Prerequisites
`course_prerequisite`	Course Prerequisites
`course_prerequisite_compare`	Course Prerequisites Compare Default: `ANY` One of: `ANY`, `ALL`
`course_points_enabled`	Enable Course Points
`course_points`	Course Points
`course_points_access`	Course Points Access
`course_disable_lesson_progression`	Disable Lesson Progression
`expire_access`	Expire Access
`expire_access_days`	Expire Access After (days)
`expire_access_delete_progress`	Delete Course and Quiz Data After Expiration

Definition #

POST /ldlms/v1/sfwd-courses

Retrieve a Sfwd Course #

Definition & Example Request #

GET /ldlms/v1/sfwd-courses/<id>

Query this endpoint to retrieve a specific sfwd course record.

$ curl https://example.com/wp-json/ldlms/v1/sfwd-courses/<id>

Sample Response #

{
    "id": 24,
    "date": "2017-04-19T19:28:55",
    "date_gmt": "2017-04-19T19:28:55",
    "guid": {
        "rendered": "http://example.com/academy/?post_type=sfwd-courses&p=24"
    },
    "modified": "2018-04-26T12:31:57",
    "modified_gmt": "2018-04-26T19:31:57",
    "slug": "in-practice",
    "status": "publish",
    "type": "sfwd-courses",
    "link": "http://example.com/courses/in-practice/",
    "title": {
        "rendered": "In Practice: Practitioner Success Series"
    },
    "content": {
        "rendered": "<h1> Course content</h1>",
        "protected": false
    },
    "author": 12,
    "featured_media": 394,
    "menu_order": 0,
    "template": "",
    "categories": [
        10
    ],
    "tags": [
        147,
        145
    ],
    "ld_course_category": [],
    "ld_course_tag": [],
    "course_materials": "",
    "course_price_type": "free",
    "custom_button_label": "",
    "custom_button_url": "",
    "course_price": "",
    "course_prerequisite_enabled": "off",
    "course_prerequisite": [],
    "course_prerequisite_compare": "ANY",
    "course_points_enabled": "",
    "course_points": "0",
    "course_points_access": "0",
    "course_disable_lesson_progression": "on",
    "expire_access": "",
    "expire_access_days": "",
    "expire_access_delete_progress": "",
    "_links": {
        "self": [
            {
                "href": "http://example.com/wp-json/ldlms/v1/sfwd-courses/24"
            }
        ],
        "collection": [
            {
                "href": "http://example.com/wp-json/ldlms/v1/sfwd-courses"
            }
        ],
        "about": [
            {
                "href": "http://example.com/wp-json/wp/v2/types/sfwd-courses"
            }
        ],
        "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-courses/24/revisions"
            }
        ],
        "steps": [
            {
                "embeddable": true,
                "href": "http://example.com/wp-json/ldlms/v1/sfwd-courses/24/steps"
            }
        ],
        "users": [
            {
                "embeddable": true,
                "href": "http://example.com/wp-json/ldlms/v1/sfwd-courses/24/users"
            }
        ],
        "groups": [
            {
                "embeddable": true,
                "href": "http://example.com/wp-json/ldlms/v1/sfwd-courses/24/groups"
            }
        ],
        "wp:featuredmedia": [
            {
                "embeddable": true,
                "href": "http://example.com/wp-json/wp/v2/media/394"
            }
        ],
        "wp:attachment": [
            {
                "href": "http://example.com/wp-json/wp/v2/media?parent=24"
            }
        ],
        "wp:term": [
            {
                "taxonomy": "category",
                "embeddable": true,
                "href": "http://example.com/wp-json/wp/v2/categories?post=24"
            },
            {
                "taxonomy": "post_tag",
                "embeddable": true,
                "href": "http://example.com/wp-json/wp/v2/tags?post=24"
            },
            {
                "taxonomy": "ld_course_category",
                "embeddable": true,
                "href": "http://example.com/wp-json/wp/v2/ld_course_category?post=24"
            },
            {
                "taxonomy": "ld_course_tag",
                "embeddable": true,
                "href": "http://example.com/wp-json/wp/v2/ld_course_tag?post=24"
            }
        ],
        "curies": [
            {
                "name": "wp",
                "href": "https://api.w.org/{rel}",
                "templated": true
            }
        ]
    }
}

Expand code

Arguments #

id

Unique identifier for the object.

Required: 1

context

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

Default: view

One of: view, embed, edit

password

The password for the post if it is password protected.

Update a Sfwd Course #

Arguments #

`id`	Unique identifier for the object. Required: 1
`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.
`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_course_category`	The terms assigned to the object in the ld_course_category taxonomy.
`ld_course_tag`	The terms assigned to the object in the ld_course_tag taxonomy.
`course_materials`	Course Materials
`course_price_type`	Course Price Type One of: `open`, `closed`, `free`, `buynow`, `subscribe`
`custom_button_label`	Custom Button Label
`custom_button_url`	Custom Button URL
`course_price`	Course Price
`course_prerequisite_enabled`	Enable Course Prerequisites
`course_prerequisite`	Course Prerequisites
`course_prerequisite_compare`	Course Prerequisites Compare One of: `ANY`, `ALL`
`course_points_enabled`	Enable Course Points
`course_points`	Course Points
`course_points_access`	Course Points Access
`course_disable_lesson_progression`	Disable Lesson Progression
`expire_access`	Expire Access
`expire_access_days`	Expire Access After (days)
`expire_access_delete_progress`	Delete Course and Quiz Data After Expiration

Definition #

POST /ldlms/v1/sfwd-courses/<id>

Example Request #

$ curl -X POST https://example.com/wp-json/ldlms/v1/sfwd-courses/<id> -d '{"title":"Course title"}'

Delete a Sfwd Course #

Arguments #

id

Unique identifier for the object.

Required: 1

force

Whether to bypass trash and force deletion.

Definition #

DELETE /ldlms/v1/sfwd-courses/<id>

Example Request #

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

Sfwd Courses

Contents

Schema #

List Sfwd Courses #

Definition #

Example Request #

Arguments #

Create a Sfwd Course #

Arguments #

Definition #

Retrieve a Sfwd Course #

Definition & Example Request #

Sample Response #

Arguments #

Update a Sfwd Course #

Arguments #

Definition #

Example Request #

Delete a Sfwd Course #

Arguments #

Definition #

Example Request #

The Most Trusted Online Course Platform for WordPress.