Meetings
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : MeetingCollection
- Returns a list of section meetings for a given date. When ```end\_date``` is supplied a range of meetings between the given dates is returned.
- searchByStudentId() : StudentScheduleCollection
- Returns a list of meetings for a given student for a specific date.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/schedules/{student_id}/meetings"
Methods
list_()
Returns a list of section meetings for a given date. When ```end\_date``` is supplied a range of meetings between the given dates is returned.
public
list_(array<string|int, mixed> $params) : MeetingCollection
offering\_types can take a single or multiple values as a comma
delimited string of integers, defaults to 1
end\_date cannot be more than 30 days past the start\_date.
Default date range is 30 days.
-
Academics: 1
-
Activities: 2
-
Advisory: 3
-
Athletics: 9
Requires at least one of the following roles in the Education Management system: - Academics Group Manager
-
Advisory Group Manager
-
Platform Manager
-
Activity Group Manager
-
Athletic Group Manager
-
Scheduling Manager
Parameters
- $params : array<string|int, mixed>
Tags
Return values
MeetingCollection —Success
searchByStudentId()
Returns a list of meetings for a given student for a specific date.
public
searchByStudentId(array{student_id: int, start_date: string, end_date: string} $params) : StudentScheduleCollection
When end\_date is supplied a range of meetings between the given
dates is returned.
end\_date cannot be more than 30 days past the start\_date.
Default date range is 30 days.
Requires at least one of the following roles in the Education Management system and group page access should be set for one of the roles:
-
Student
-
Parent
-
Attendance Manager
-
Schedule Manager
Parameters
- $params : array{student_id: int, start_date: string, end_date: string}
-
An associative array
- student_id: Format - int32.
- start_date: Format - date-time (as date-time in RFC3339).
- end_date: Format - date-time (as date-time in RFC3339).
Tags
Return values
StudentScheduleCollection —Success