Session Roster
Use this API to update and fetch roster for Instructor-Led Training (ILT) sessions.
Create
This endpoint allows you to update the session attendance roster as well as complete the session.
- You can only send one roster submission per request.
- Users should be registered in the Session before their attendance can be updated using this endpoint. To register users to Sessions, use the Learning Assignment API.
- The session should be past-dated.
Permission Required: Roster - Manage (the user passed in the ActorID parameter in the request body must have this permission)
OAuth 2.0 Scope: sessionroster:create
Error Descriptions
Handled Error List
| Error Types | Error Message |
|---|---|
| SessionLOID | Invalid Session LOID |
| UserID | UserID Missing / Invalid User / User not registered to session. |
| Score | Invalid Score |
| PartName | Duplicate Part Name or Part Id / Part Name or Part Id does not exist |
Get Details
This endpoint allows you to retrieve the roster details of an ILT Session.
Localization:
The following response fields support localization. The API considers the language of the user associated with the OAuth 2.0 application to determine the locale for these fields.
- OUs>Name
- OUs>TypeName
- Attendance>PartName
- Status
Permission Required: Roster - View
OAuth 2.0 Scope: sessionroster:read
Error Descriptions
Handled Error List
| Error Types | Error Message |
|---|---|
| Locator/SessionLOID/SessionNumber | Get Session roster service failed: The following Arguments are missing: locator/sessionLOID/session number |
| SessionNumber | Multiple session found |
| SessionNumber | Session not found |