Skip to navigation

Register Live Session Attendance

Register the attendance of users in a live session.

Send user_ids to mark those users, or all_participants: true to mark every participant of the session. The registration is processed in background: a 202 means the request was accepted for the users reported in total_users_accepted, and errors explains each user left out (already registered, not found in the organization, inactive).

User ids are learning user ids: take them from user.id in GET /org/{organization_slug}/learning/users/ or from learning_user_id in GET /org/{organization_slug}/users/user-organizations/ (where user.id is the centralized id). A centralized user id targets a different person.

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

organization_slugstringRequired
live_session_idintegerRequired>=1
Id of the live session, as returned by GET

Headers

Secret-AccessstringRequired

Request

This endpoint expects an object.
user_idslist of integersOptional

Learning user ids to mark as attendees. Required unless all_participants is true. These are learning user ids, not the centralized_user_id used by the users and enrollments endpoints: sending one in place of the other targets a different person. Get them from user.id in GET /org/{organization_slug}/learning/users/ (filter with user_email; results[].id is the membership id, not the user id), or from learning_user_id in GET /org/{organization_slug}/users/user-organizations/ (there user.id is the centralized id)

all_participantsbooleanOptionalDefaults to false

Mark every participant of the session as an attendee; user_ids must be empty in that case

Response

Attendance queued for background processing
messagestring
Message of the response
codestring
Internal code of the response
datetimestring
Datetime of the API in ISO Format
dataobjectOptional
Attendance registration details

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error