v2/Questions – LearnDash Dev Docs

Schema
List Questions
Create a Question
- Arguments
- Definition
List Questions
Update a Question
Delete a Question

Schema #

The schema defines all the fields that exist within a question 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`
`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`
`quiz` integer	Quiz ID. Context: `view`, `edit`
`correct_message` html	Message shown when Question is correct. Context: `view`, `edit`
`incorrect_message` string	Message shown when Question is correct. Context: `view`, `edit`
`hints_enabled` boolean	Activate hint for this Question. Context: `view`, `edit`
`hints_message` boolean	Hint message. Context: `view`, `edit`
`points` integer	Points amount Context: `view`, `edit`
`points_per_answer` boolean	Points per answer enabled. Context: `view`, `edit`
`question_type` enum	Question type. Context: `view`, `edit` One of: `single`, `multiple`, `free_answer`, `sort_answer`, `matrix_sort_answer`, `cloze_answer`, `assessment_answer`, `essay`
`answer_sets` object	Question answer sets. Context: `view`, `edit`

List Questions #

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

Definition #

GET /ldlms/v2/sfwd-question

Example Request #

$ curl https://example.com/wp-json/ldlms/v2/sfwd-question

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.
`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: `desc` One of: `asc`, `desc`
`orderby`	Sort collection by object attribute. Default: `date` 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`

Create a Question #

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.
`quiz`	Quiz ID.
`correct_message`	Message shown when Question is correct.
`incorrect_message`	Message shown when Question is correct.
`hints_enabled`	Activate hint for this Question.
`hints_message`	Hint message.
`points`	Points amount
`points_per_answer`	Points per answer enabled.
`question_type`	Question type. Default: `single` One of: `single`, `multiple`, `free_answer`, `sort_answer`, `matrix_sort_answer`, `cloze_answer`, `assessment_answer`, `essay`
`answer_sets`	Question answer sets. Required: 1

Definition #

POST /ldlms/v2/sfwd-question

List Questions #

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

Definition #

GET /ldlms/v2/sfwd-question/<id>

Example Request #

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

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.
`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: `desc` One of: `asc`, `desc`
`orderby`	Sort collection by object attribute. Default: `date` 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`

Update a Question #

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.
`quiz`	Quiz ID.
`correct_message`	Message shown when Question is correct.
`incorrect_message`	Message shown when Question is correct.
`hints_enabled`	Activate hint for this Question.
`hints_message`	Hint message.
`points`	Points amount
`points_per_answer`	Points per answer enabled.
`question_type`	Question type. One of: `single`, `multiple`, `free_answer`, `sort_answer`, `matrix_sort_answer`, `cloze_answer`, `assessment_answer`, `essay`
`answer_sets`	Question answer sets.

Definition #

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

Example Request #

Delete a Question #

Arguments #

force

Whether to bypass trash and force deletion.

Definition #

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

Example Request #

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

Questions

Contents

Schema #

List Questions #

Definition #

Example Request #

Arguments #

Create a Question #

Arguments #

Definition #

List Questions #

Definition #

Example Request #

Arguments #

Update a Question #

Arguments #

Definition #

Example Request #

Delete a Question #

Arguments #

Definition #

Example Request #

The Most Trusted Online Course Platform for WordPress.