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 /

Course Steps

Schema #

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

id
integer

Unique identifier for the object.

Read only

Context: view, edit, embed

type
string

The course step type.

Context: view, edit

One of: all, h, l, t, r

Retrieve a Course Steps #

Definition & Example Request #

GET /ldlms/v2/sfwd-courses/<id>/steps

Query this endpoint to retrieve a specific course steps record.

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

Sample Response #


		

Arguments #

id

Course ID

Required: 1

context

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

Default: view

One of: view, embed, edit

type

Filter returned results by step type.

Default: all

One of: all, h, l, t, r

Update a Course Steps #

Arguments #

id

Course ID

Required: 1

context

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

Default: view

One of: view, embed, edit

type

Filter returned results by step type.

Default: all

One of: all, h, l, t, r

Definition #

POST /ldlms/v2/sfwd-courses/<id>/steps

Example Request #