Browse: Home / REST API Routes v2 /

User Quiz Progress

Contents

Schema
List User Quiz Progress

Schema #

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

`quiz` integer	Quiz ID Read only Context: `embed`, `view`
`course` integer	Course ID Read only Context: `embed`, `view`
`lesson` integer	Lesson ID Read only Context: `embed`, `view`
`topic` integer	Topic ID Read only Context: `embed`, `view`
`user` integer	User ID Read only Context: `embed`, `view`
`percentage` number	Percentage passed Read only Context: `view`
`timespent` number	Timespent Read only Context: `view`
`has_graded` boolean	Has Graded Read only Context: `view`
`started` string, null, datetime (details)	Started timestamp Read only Context: `view`
`completed` string, null, datetime (details)	Completed timestamp Read only Context: `view`
`points_scored` integer	Points scored Read only Context: `view`
`points_total` integer	Points total Read only Context: `view`
`statistic` integer	Statistic ID Read only Context: `view`

List User Quiz Progress #

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

Definition #

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

Example Request #

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

Arguments #

`id`	User ID Required: 1
`quiz`	Limit results to be within a specific Quiz. Required for non-admin users.
`course`	Limit results to be within a specific Course. Required for non-admin users.
`lesson`	Limit results to be within a specific Lesson. Pass zero to show global Course Quizzes. Must be used with Course parameter.
`topic`	Limit results to be within a specific Topic. Must be used with Course parameter.
`context`	Scope under which the request is made; determines fields present in response. Default: `view` One of: `view`, `embed`, `edit`
`orderby`	Default: `taken` One of: `taken`, `title`, `id`, `date`
`offset`	Offset the result set by a specific number of items.
`order`	Order sort attribute ascending or descending. Default: `asc` One of: `asc`, `desc`
`per_page`	Maximum number of items to be returned in result set. Default: `10`
`page`	Current page of the collection. Default: `1`
`search`	Limit results to those matching a string.