Quizzes

Schema #

The schema defines all the fields that exist within a quiz 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

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_materials
html

Quiz Materials

Context: view, edit

threshold
text

Certificate Threshold

Context: view, edit

passingpercentage
text

Passing Percentage

Context: view, edit

certificate
string

Associated Certificate

Context: view, edit

List Quizzes #

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

Definition #

GET /ldlms/v1/sfwd-quiz

Example Request #

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

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

course

Limit results to be within a specific Course. Required for non-admin users.

lesson

Limit results to be within a specific Lesson. Pass zero to show global Course Quizzes. Must be used with course parameter.

topic

Limit results to be within a specific Topic. Must be used with course parameter.

Create a Quiz #

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_materials

Quiz Materials

threshold

Certificate Threshold

Default: 0.8

passingpercentage

Passing Percentage

Default: 80

certificate

Associated Certificate

Definition #

POST /ldlms/v1/sfwd-quiz

Retrieve a Quiz #

Definition & Example Request #

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

Query this endpoint to retrieve a specific quiz record.

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

Sample Response #

{
    "id": 57820,
    "date": "2018-08-16T13:52:31",
    "date_gmt": "2018-08-16T20:52:31",
    "guid": {
        "rendered": "https://example.com/?post_type=sfwd-quiz&p=57820"
    },
    "modified": "2018-08-27T06:40:11",
    "modified_gmt": "2018-08-27T13:40:11",
    "slug": "accountability-log-week-10",
    "status": "publish",
    "type": "sfwd-quiz",
    "link": "http://example.com/courses/health-coach-training-program/quizzes/accountability-log-week-10/",
    "title": {
        "rendered": "Accountability Log Week 10"
    },
    "content": {
        "rendered": "<p>This log will track your meditation, journaling and practice partner sessions. Please wait to take this quiz until after Week 10 is complete. Your results will be shown on the<a href="https://example.com/hctp/report-card/"> Report Card</a> page.</p>n",
        "protected": false
    },
    "author": 12,
    "featured_media": 0,
    "menu_order": 0,
    "template": "",
    "quiz_materials": "",
    "threshold": "0.7",
    "passingpercentage": "70",
    "certificate": "0",
    "_links": {
        "self": [
            {
                "href": "http://example.com/wp-json/ldlms/v1/sfwd-quiz/57820"
            }
        ],
        "collection": [
            {
                "href": "http://example.com/wp-json/ldlms/v1/sfwd-quiz"
            }
        ],
        "about": [
            {
                "href": "http://example.com/wp-json/wp/v2/types/sfwd-quiz"
            }
        ],
        "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-quiz/57820/revisions"
            }
        ],
        "wp:attachment": [
            {
                "href": "http://example.com/wp-json/wp/v2/media?parent=57820"
            }
        ],
        "curies": [
            {
                "name": "wp",
                "href": "https://api.w.org/{rel}",
                "templated": true
            }
        ]
    }
}

Arguments #

id

Unique identifier for the Quiz object.

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 Quiz #

Arguments #

id

Unique identifier for the Quiz 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.

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_materials

Quiz Materials

threshold

Certificate Threshold

passingpercentage

Passing Percentage

certificate

Associated Certificate

Definition #

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

Example Request #

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

Delete a Quiz #

Arguments #

id

Unique identifier for the Quiz object.

force

Whether to bypass trash and force deletion.

Definition #

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

Example Request #

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