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 /

User Course Progress

Contents

Schema #

The schema defines all the fields that exist within a user course progress 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.

course
integer

Course ID

Read only

Context: embed, view
progress_status
string

Course Progress Status

Read only

Context: embed, view

One of: not-started, in-progress, completed
last_step
integer

Last completed step

Read only

Context: embed, view
steps_completed
integer

Total completed steps

Read only

Context: view
steps_total
integer

Total Course steps

Read only

Context: view
date_started
string, null, datetime (details)

Date started

Read only

Context: view
date_completed
string, null, datetime (details)

Date completed

Read only

Context: view

List User Course Progress #

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

Definition #

GET /ldlms/v2/users/<id>/course-progress

Example Request #

$ curl https://example.com/wp-json/ldlms/v2/users/<id>/course-progress

Arguments #

id

User ID

Required: 1

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view
exclude

Ensure result set excludes specific IDs.
include

Limit result set to specific IDs.
per_page

Maximum number of items to be returned in result set.

Default: 10

page

Current page of the collection.

Default: 1

List User Course Progress #

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

Definition #

GET /ldlms/v2/users/<id>/course-progress/<course>

Example Request #

$ curl https://example.com/wp-json/ldlms/v2/users/<id>/course-progress/<course>

Arguments #

id

User ID

Required: 1

context

Scope under which the request is made; determines fields present in response.

Default: view

One of: view
exclude

Ensure result set excludes specific IDs.
include

Limit result set to specific IDs.
per_page

Maximum number of items to be returned in result set.

Default: 10

page

Current page of the collection.

Default: 1