Schema #
The schema defines all the fields that exist within a course prerequisites 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: |
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_course_category array |
The terms assigned to the object in the ld_course_category taxonomy. Context: |
ld_course_tag array |
The terms assigned to the object in the ld_course_tag taxonomy. Context: |
materials_enabled boolean |
Materials Eabled Context: |
materials string |
Materials Context: |
certificate integer |
Course Certificate Context: |
disable_content_table boolean |
Disable Course Content Table Context: |
lessons_per_page boolean |
Custom Pagination Context: |
lesson_per_page_custom integer |
Lessons per page Context: |
topic_per_page_custom integer |
Topics per page Context: |
price_type string |
Course Price Type Context: One of: |
price_type_paynow_price string |
Pay Now Course Price Context: |
price_type_subscribe_price string |
Subscribe Course Price Context: |
price_type_closed_price string |
Closed Course Price Context: |
price_type_closed_custom_button_url string |
Closed Course Button URL Context: |
prerequisite_enabled boolean |
Course Prerequisites Context: |
prerequisite_compare string |
Prerequisite Compare Mode. Context: One of: |
prerequisites array |
Prerequisites. Context: |
points_enabled boolean |
Course Points Context: |
points_access float |
Required for Access Context: |
points_amount float |
Awarded on Completion Context: |
progression_disabled boolean |
Course Progression Disabled Context: |
List Course Prerequisites #
Query this endpoint to retrieve a collection of course prerequisites. The response you receive can be controlled and filtered using the URL query parameters below.
Definition #
GET /ldlms/v2/sfwd-courses/<id>/prerequisites
Example Request #
$ curl https://example.com/wp-json/ldlms/v2/sfwd-courses/<id>/prerequisites
Arguments #
id |
Course ID Required: 1 |
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_course_category |
Limit result set to items with specific terms assigned in the ld_course_category taxonomy. |
ld_course_category_exclude |
Limit result set to items except those with specific terms assigned in the ld_course_category taxonomy. |
ld_course_tag |
Limit result set to items with specific terms assigned in the ld_course_tag taxonomy. |
ld_course_tag_exclude |
Limit result set to items except those with specific terms assigned in the ld_course_tag taxonomy. |