The REST API V2 is current in beta. New endpoints are still being added and the parameters of existing endpoints may change.

Browse: Home / REST API Routes v2 /

Essays

Contents

Schema #

The schema defines all the fields that exist within a essay 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: 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
comment_status
string

Whether or not comments are open on the object.

Context: view, edit

One of: open, closed
ping_status
string

Whether or not the object can be pinged.

Context: view, edit

One of: open, closed
template
string

The theme file to use to display the object.

Context: view, edit
course
integer

Course ID

Context: view
lesson
integer

Lesson ID

Context: view
topic
integer

Topic ID

Context: view
points_max
integer

Essay Points Maximum

Context: view
points_awarded
integer

Essay Points Awarded

Context: view, edit

List Essays #

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

Definition #

GET /ldlms/v2/sfwd-essays

Example Request #

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

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.
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
slug

Limit result set to posts with one or more specific slugs.
status

Limit result set to posts assigned one or more statuses.

Default: any

course

Filter by Course ID
lesson

Filter by Lesson ID
topic

Filter by Topic ID

List Essays #

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

Definition #

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

Example Request #

$ curl https://example.com/wp-json/ldlms/v2/sfwd-essays/<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.
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
slug

Limit result set to posts with one or more specific slugs.
status

Limit result set to posts assigned one or more statuses.

Default: any

course

Filter by Course ID
lesson

Filter by Lesson ID
topic

Filter by Topic ID

Update a Essay #

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.
comment_status

Whether or not comments are open on the object.

One of: open, closed
ping_status

Whether or not the object can be pinged.

One of: open, closed
template

The theme file to use to display the object.
course

Course ID
lesson

Lesson ID
topic

Topic ID
points_max

Essay Points Maximum
points_awarded

Essay Points Awarded

Definition #

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

Example Request #