users

Returns user course progress for a specific course by uid

get/v1/users/course-progress/{courseId}/by-uid/{uid}

Request

  • Base URL: https://api.memberspot.de (the document declares no server; this is the origin it was published from)
  • URL: https://api.memberspot.de/v1/users/course-progress/{courseId}/by-uid/{uid}
  • Auth: API key in header X-API-KEY

Path parameters

uidstring required

Uid to search for

courseIdstring required

The course ID to get progress for

Response

Returns user course progress for a specific course by uid

uidstring required

User identifier

emailstring required

User email

firstnamestring required

Users firstname

namestring required

Users lastname

activeboolean

Is course active

courseIdstring required

Course id

activePostsnumber

Number of lessons that count towards the course progress of this user (published lessons in accessible chapters). Omitted when the user does not have the course.

completedPostsnumber

Number of completed lessons of this user in the course. The course counts as completed when activePosts > 0 and completedPosts >= activePosts (SCORM courses track completion separately). Omitted when the user does not have the course.

grantedAtstring date-time

Date the course was first granted to the user. Revoking and re-granting access keeps this date; check "active" for the current access state. Omitted when the user never had the course.

startDatestring date-time

Date from which course access and drip scheduling are anchored for the user. Derived from the offer launch date or set by an admin, so it can be before or after grantedAt. Omitted when the user never had the course.

updatedAtstring date-time

Date the course assignment was last written. It changes whenever progress, access state, chapter access or start date change, and can also move when the access of the user is re-evaluated without a visible change. An unchanged value therefore guarantees unchanged data; a newer value does not guarantee a difference. Omitted for assignments that have not been written since the field was introduced.

Changes