Groups

Schema #

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

title
object

The title for the object.

Context: view, edit, embed

content
object

The content for the object.

Context: view, edit

template
string

The theme file to use to display the object.

Context: view, edit

List Groups #

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

Definition #

GET /ldlms/v1/groups

Example Request #

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

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.

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.

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

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

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.

template

The theme file to use to display the object.

Definition #

POST /ldlms/v1/groups

Retrieve a Group #

Definition & Example Request #

GET /ldlms/v1/groups/<id>

Query this endpoint to retrieve a specific group record.

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

Sample Response #

{
    "id": 19195,
    "date": "2018-04-19T13:19:38",
    "date_gmt": "2018-04-19T20:19:38",
    "guid": {
        "rendered": "https://example.com/?post_type=groups&p=19195"
    },
    "modified": "2018-06-18T09:18:26",
    "modified_gmt": "2018-06-18T16:18:26",
    "slug": "health-coach-training-program-2017-2018",
    "status": "publish",
    "type": "groups",
    "link": "http://learndash.test/groups/health-coach-training-program-2017-2018/",
    "title": {
        "rendered": "Health Coach Training Program – 2017-2018"
    },
    "content": {
        "rendered": "",
        "protected": false
    },
    "template": "",
    "_links": {
        "self": [
            {
                "href": "http://learndash.test/wp-json/ldlms/v1/groups/19195"
            }
        ],
        "collection": [
            {
                "href": "http://learndash.test/wp-json/ldlms/v1/groups"
            }
        ],
        "about": [
            {
                "href": "http://learndash.test/wp-json/wp/v2/types/groups"
            }
        ],
        "wp:attachment": [
            {
                "href": "http://learndash.test/wp-json/wp/v2/media?parent=19195"
            }
        ],
        "curies": [
            {
                "name": "wp",
                "href": "https://api.w.org/{rel}",
                "templated": true
            }
        ]
    }
}

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

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.

template

The theme file to use to display the object.

Definition #

POST /ldlms/v1/groups/<id>

Example Request #

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

Delete a Group #

Arguments #

id

Unique identifier for the object.

Required: 1

force

Whether to bypass trash and force deletion.

Definition #

DELETE /ldlms/v1/groups/<id>

Example Request #

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