Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Classrooms

Register a user to a classroom slot

🔑

Required OAuth scope: classrooms:write.

Registers a user to a classroom slot based on the provided classroom slot ID and user ID.

post/api/v2/classroom-slots/{classroomSlotId}/registrations/{userId}

Path parameters

classroomSlotIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the classroom slot.

userIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the user.

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns the created slot registration.

_idstring ObjectId required

The unique ID of the classroom slot registration.

archivedAtstring date-time

The date and time when the slot registration was archived from the path session, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

userIdstring ObjectId required

The unique ID of the registered user.

attendanceDurationnumber

If the classroom is setup through a webinar integration, contains the reported duration of the attendance in milliseconds.

createdAtstring date-time

The date and time when the slot registration has been created, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

hasAttendedboolean

The attendance status of the registration.

modifiedAtstring date-time

The date and time when the slot registration has been modified, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

pathIdstring ObjectId

The ID of the path in which this registration was made (if any).

status'archived' | 'published' required

The status of the slot registration.

Example response

{
  "_id": "507f1f77bcf86cd799439011",
  "userId": "507f1f77bcf86cd799439011",
  "attendanceDuration": 60,
  "pathId": "507f1f77bcf86cd799439011"
}