Schedules
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : ScheduleItemCollection
- Returns a collection of athletic games for the current school year.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/athletics/schedules"
Endpoint URL pattern
Methods
list_()
Returns a collection of athletic games for the current school year.
public
list_(array{start_date: string, end_date: string, school_year: string, include_practice?: bool, team_id?: int, last_modified: string} $params) : ScheduleItemCollection
Use the start\_date and/or end\_date to filter to a
specific timeframe.
Returns data for a specific team by setting the team\_id using
the GET teams endpoint.
Returns both games and practices by setting include\_practice to
true.
Requires at least one of the following roles in the Education Management system:
-
Athletic Group Manager
-
Team Schedule Manager
-
Schedule Manager
-
Coach
-
Pending Coach
Parameters
- $params : array{start_date: string, end_date: string, school_year: string, include_practice?: bool, team_id?: int, last_modified: string}
-
An associative array
- start_date: Format - date-time (as date-time in RFC3339). Filter games/practices after this date
- end_date: Format - date-time (as date-time in RFC3339). Filter games/practices before this date
- school_year: Filter on a specific school year. Defaults to current school year.
- include_practice: Set to
trueto include practices with games. Defaults to false. - team_id: Format - int32. Filter games/practices for a specific team. Defaults to all teams.
- last_modified: Format - date-time (as date-time in RFC3339). Set date to limit results to games with information changed on and after that date.
Tags
Return values
ScheduleItemCollection —Success