Documentation

AppointmentGroup extends AbstractBaseApi

in package

• CanvasLMS
• Api
• AppointmentGroups

AppointmentGroup Class

// Creating an appointment group
$dto = new CreateAppointmentGroupDTO();
$dto->contextCodes = ['course_123'];
$dto->title = 'Office Hours';
$dto->description = 'Weekly office hours for questions';
$dto->newAppointments = [
    ['start_at' => '2025-03-15T10:00:00Z', 'end_at' => '2025-03-15T10:30:00Z'],
    ['start_at' => '2025-03-15T10:30:00Z', 'end_at' => '2025-03-15T11:00:00Z']
];
$dto->participantsPerAppointment = 1;
$appointmentGroup = AppointmentGroup::create($dto);

// Finding an appointment group
$appointmentGroup = AppointmentGroup::find(543);

// Listing appointment groups
$groups = AppointmentGroup::get(['scope' => 'manageable']);

// Publishing an appointment group
$appointmentGroup->publish();

// Listing participants
$users = $appointmentGroup->listUsers();

Tags

see

https://canvas.instructure.com/doc/api/appointment_groups.html

Table of Contents

Properties

$allowObserverSignup  : bool|null

Boolean indicating whether observer users should be able to sign-up for an appointment

$appointments  : array<int, array<string, mixed>>|null

Calendar Events representing the time slots

$appointmentsCount  : int|null

Number of time slots in this appointment group

$contextCodes  : array<int, string>|null

The context codes this appointment group belongs to

$createdAt  : DateTime|null

When the appointment group was created

$description  : string|null

The text description of the appointment group

$endAt  : DateTime|null

The end of the last time slot in the appointment group

$htmlUrl  : string|null

URL for a user to view this appointment group

$id  : int|null

The ID of the appointment group

$locationAddress  : string|null

The address of the appointment group's location

$locationName  : string|null

The location name of the appointment group

$maxAppointmentsPerParticipant  : int|null

Maximum number of time slots a user may register for

$minAppointmentsPerParticipant  : int|null

Minimum number of time slots a user must register for

$newAppointments  : array<int, array<string, mixed>>|null

Newly created time slots (only in create/update responses)

$participantCount  : int|null

The number of participants who have reserved slots

$participantsPerAppointment  : int|null

Maximum number of participants that may register for each time slot

$participantType  : string|null

How participants sign up: 'User' or 'Group'

$participantVisibility  : string|null

'private' means participants cannot see who has signed up 'protected' means that they can

$requiringAction  : bool|null

Boolean indicating whether the current user needs to sign up

$reservedTimes  : array<int, array<string, mixed>>|null

The start and end times of slots reserved by the current user

$startAt  : DateTime|null

The start of the first time slot in the appointment group

$subContextCodes  : array<int, string>|null

The sub-context codes this appointment group is restricted to

$title  : string|null

The title of the appointment group

$updatedAt  : DateTime|null

When the appointment group was last updated

$url  : string|null

URL for this appointment group

$workflowState  : string|null

Current state of the appointment group ('pending', 'active' or 'deleted')

$apiClient  : HttpClientInterface

$methodAliases  : array<string|int, mixed>

Define method aliases

Methods

__callStatic()  : mixed

Magic method to handle function aliases

__construct()  : mixed

Constructor

__set()  : void

Magic setter to handle property casting

all()  : array<string|int, static>

Get all pages of results

create()  : self

Create a new appointment group

delete()  : self

Delete an appointment group

find()  : self

Find an appointment group by ID

get()  : array<int, self>

List appointment groups

getCalendarEvents()  : array<string|int, CalendarEvent>

Get calendar events (time slots) for this appointment group

listGroups()  : array<string, mixed>

List group participants

listGroupsPaginated()  : PaginatedResponse

List group participants (paginated)

listUsers()  : array<string, mixed>

List user participants

listUsersPaginated()  : PaginatedResponse

List user participants (paginated)

paginate()  : PaginationResult

Get paginated results with metadata

publish()  : self

Publish the appointment group (make it available for sign-up)

save()  : self

Save the appointment group (create or update)

setApiClient()  : void

Set the API client

update()  : self

Update an appointment group

castValue()  : mixed

Cast value to appropriate type based on property

checkApiClient()  : void

Check if the API client is set, if not, instantiate a new one

convertPaginatedResponseToModels()  : array<string|int, static>

Helper method to convert paginated response data to model instances

createConfiguredHttpClient()  : HttpClient

Create an HttpClient with configured middleware

createPaginationResult()  : PaginationResult

Helper method to create PaginationResult from paginated response

getEndpoint()  : string

Get the API endpoint for this resource

getPaginatedResponse()  : PaginatedResponse

Helper method to get paginated response from API endpoint

populate()  : void

Populate the object with new data

toDtoArray()  : array<string|int, mixed>

Convert the object to an array