Contents
Schema #
The schema defines all the fields that exist within a course step 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: |
type
string |
The course step type.
Context: all, h, l, t, r |
Retrieve a Course Step #
Definition & Example Request #
GET /ldlms/v1/sfwd-courses/<id>/steps
Query this endpoint to retrieve a specific course step record.
$ curl https://example.com/wp-json/ldlms/v1/sfwd-courses/<id>/steps
Sample Response #
{
"sfwd-lessons": {
"667": {
"sfwd-topic": {
"1490": {
"sfwd-quiz": []
},
"1493": {
"sfwd-quiz": []
},
"1496": {
"sfwd-quiz": []
},
"1499": {
"sfwd-quiz": []
},
"1501": {
"sfwd-quiz": []
},
"1503": {
"sfwd-quiz": []
}
},
"sfwd-quiz": []
},
"668": {
"sfwd-topic": {
"1505": {
"sfwd-quiz": []
},
"1507": {
"sfwd-quiz": []
},
"1516": {
"sfwd-quiz": []
},
"1518": {
"sfwd-quiz": []
},
"1519": {
"sfwd-quiz": []
}
},
"sfwd-quiz": []
},
"669": {
"sfwd-topic": {
"1245": {
"sfwd-quiz": []
},
"1299": {
"sfwd-quiz": []
},
"1308": {
"sfwd-quiz": []
},
"1309": {
"sfwd-quiz": []
},
"1310": {
"sfwd-quiz": []
}
},
"sfwd-quiz": []
},
"670": {
"sfwd-topic": {
"1314": {
"sfwd-quiz": []
},
"1315": {
"sfwd-quiz": []
},
"1316": {
"sfwd-quiz": []
},
"1317": {
"sfwd-quiz": []
}
},
"sfwd-quiz": []
},
"671": {
"sfwd-topic": {
"1365": {
"sfwd-quiz": []
},
"1368": {
"sfwd-quiz": []
},
"1369": {
"sfwd-quiz": []
},
"1370": {
"sfwd-quiz": []
}
},
"sfwd-quiz": []
},
"672": {
"sfwd-topic": {
"1371": {
"sfwd-quiz": []
},
"1372": {
"sfwd-quiz": []
},
"1373": {
"sfwd-quiz": []
},
"1374": {
"sfwd-quiz": []
},
"1375": {
"sfwd-quiz": []
}
},
"sfwd-quiz": []
},
"673": {
"sfwd-topic": {
"1382": {
"sfwd-quiz": []
},
"1384": {
"sfwd-quiz": []
},
"1416": {
"sfwd-quiz": []
},
"1418": {
"sfwd-quiz": []
}
},
"sfwd-quiz": []
},
"674": {
"sfwd-topic": {
"1430": {
"sfwd-quiz": []
},
"1432": {
"sfwd-quiz": []
},
"1434": {
"sfwd-quiz": []
},
"1435": {
"sfwd-quiz": []
},
"1436": {
"sfwd-quiz": []
}
},
"sfwd-quiz": []
}
},
"sfwd-quiz": []
}
Arguments #
id |
Course ID to enroll user into.
Required: 1 |
context |
Scope under which the request is made; determines fields present in response.
Default: view, embed, edit |
type |
Filter returned results by step type.
Default: all, h, l, t, r |
Definition #
POST /ldlms/v1/sfwd-courses/<id>/steps
Example Request #
$ curl -X POST https://example.com/wp-json/ldlms/v1/sfwd-courses/<course_id>/steps -H "Content-Type: application/json" -d '{"sfwd-lessons":{"1":{"sfwd-topic":{"10":{"sfwd-quiz":[]}},"sfwd-quiz":[]},"2":{"sfwd-topic":{},"sfwd-quiz":[]},"3":{"sfwd-topic":{},"sfwd-quiz":[]}},"sfwd-quiz":[]}'