Appointment Groups
Appointment Groups API
// Date and time for an appointment
{
// The appointment identifier.
"id": 987,
// Start time for the appointment
"start_at": "2012-07-20T15:00:00-06:00",
// End time for the appointment
"end_at": "2012-07-20T15:00:00-06:00"
}{
// The ID of the appointment group
"id": 543,
// The title of the appointment group
"title": "Final Presentation",
// The start of the first time slot in the appointment group
"start_at": "2012-07-20T15:00:00-06:00",
// The end of the last time slot in the appointment group
"end_at": "2012-07-20T17:00:00-06:00",
// The text description of the appointment group
"description": "Es muy importante",
// The location name of the appointment group
"location_name": "El Tigre Chino's office",
// The address of the appointment group's location
"location_address": "Room 234",
// The number of participant who have reserved slots (see include[] argument)
"participant_count": 2,
// The start and end times of slots reserved by the current user as well as the
// id of the calendar event for the reservation (see include[] argument)
"reserved_times": [{"id":987,"start_at":"2012-07-20T15:00:00-06:00","end_at":"2012-07-20T15:00:00-06:00"}],
// Boolean indicating whether observer users should be able to sign-up for an
// appointment
"allow_observer_signup": false,
// The context codes (i.e. courses) this appointment group belongs to. Only
// people in these courses will be eligible to sign up.
"context_codes": ["course_123"],
// The sub-context codes (i.e. course sections and group categories) this
// appointment group is restricted to
"sub_context_codes": [course_section_234],
// Current state of the appointment group ('pending', 'active' or 'deleted').
// 'pending' indicates that it has not been published yet and is invisible to
// participants.
"workflow_state": "active",
// Boolean indicating whether the current user needs to sign up for this
// appointment group (i.e. it's reservable and the
// min_appointments_per_participant limit has not been met by this user).
"requiring_action": true,
// Number of time slots in this appointment group
"appointments_count": 2,
// Calendar Events representing the time slots (see include[] argument) Refer to
// the Calendar Events API for more information
"appointments": [],
// Newly created time slots (same format as appointments above). Only returned
// in Create/Update responses where new time slots have been added
"new_appointments": [],
// Maximum number of time slots a user may register for, or null if no limit
"max_appointments_per_participant": 1,
// Minimum number of time slots a user must register for. If not set, users do
// not need to sign up for any time slots
"min_appointments_per_participant": 1,
// Maximum number of participants that may register for each time slot, or null
// if no limit
"participants_per_appointment": 1,
// 'private' means participants cannot see who has signed up for a particular
// time slot, 'protected' means that they can
"participant_visibility": "private",
// Indicates how participants sign up for the appointment group, either as
// individuals ('User') or in student groups ('Group'). Related to
// sub_context_codes (i.e. 'Group' signups always have a single group category)
"participant_type": "User",
// URL for this appointment group (to update, delete, etc.)
"url": "https://example.com/api/v1/appointment_groups/543",
// URL for a user to view this appointment group
"html_url": "http://example.com/appointment_groups/1",
// When the appointment group was created
"created_at": "2012-07-13T10:55:20-06:00",
// When the appointment group was last updated
"updated_at": "2012-07-13T10:55:20-06:00"
}Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Parameter
Type
Description
Last updated
Was this helpful?