Attendance Object


The attendance object represents the attendance information for a booked session, such as:

  • Did anyone attend the session?
  • How many people attended the session?

The number of session attendance objects available depends on the booking type:

  • Appointment bookings have 1 attendance object per appointment session.
  • Class bookings have 1 attendance object for each session of the class. The number of sessions for a class is defined in Schedule and Sessions schedule.capacity property.
  • Course bookings have an attendance object for each session of the course. For example, if there are 12 sessions in a course, there are 12 attendance objects. The number of sessions for a class is defined in Schedule and Sessions schedule.capacity property.
Properties
bookingIdstringformat GUID

Corresponding booking ID.


eventIdstringminLength 36maxLength 250

Corresponding event ID. Use this field instead of the deprecated sessionId. You can retrieve the event ID from the booking's slot booking.bookedEntity.slot.eventId.


idstringRead-onlyformat GUID

ID of the attendance object.


numberOfAttendeesinteger

Total number of participants that attended the session. By default, the number of attendees is set to 1, but you can set a number to greater than 1 if multiple participants attended.

Do not set to 0 to indicate that no one attended the session. Instead, set the status field to NOT_ATTENDED.

Default: 1


sessionIdstringdeprecated - use eventId instead

Corresponding session ID.

Deprecated.* Use eventId instead.


statusstring
Did this help?