Schedule
extends BaseEndpoint
in package
Routing class for the subnamespace `Schedule`
Tags
Table of Contents
Properties
- $_practice : Practice|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- deleteByTeamIdAndGameId() : mixed
- Removes an athletic ```game\_id``` for the specified ```team\_id```.
- patchOnTeamId() : mixed
- Updates the game data for the specified ```team\_id``` and athletic ```game\_id```.
- postToTeamId() : int
- Creates a new athletic game for the specified ```team\_id```.
Properties
$_practice
protected
Practice|null
$_practice
= null
$_practice
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["practice" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Athletics\\Teams\\Schedule\\Practice"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/athletics/teams/{team_id}/schedule/{game_id}"
Methods
deleteByTeamIdAndGameId()
Removes an athletic ```game\_id``` for the specified ```team\_id```.
public
deleteByTeamIdAndGameId(array{team_id: int, game_id: int} $params) : mixed
Requires at least one of the following roles in the Education Management system:
-
Team Schedule Manager
-
Page Manager
Parameters
- $params : array{team_id: int, game_id: int}
-
An associative array
- team_id: Format - int32. ID of the team for the game to be deleted
- game_id: Format - int32. ID of the game to be deleted
Tags
Return values
mixed —Success
patchOnTeamId()
Updates the game data for the specified ```team\_id``` and athletic ```game\_id```.
public
patchOnTeamId(array{team_id: int} $params, GameUpdate $requestBody) : mixed
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{team_id: int}
-
An associative array
- team_id: Format - int32. ID of the team for the game to be updated
- $requestBody : GameUpdate
-
Information for the game to be updated
Tags
Return values
mixed —Success
postToTeamId()
Creates a new athletic game for the specified ```team\_id```.
public
postToTeamId(array{team_id: int} $params, GameCreate $requestBody) : int
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{team_id: int}
-
An associative array
- team_id: Format - int32. ID of the team for the game to be created
- $requestBody : GameCreate
-
Information about the game to be created
Tags
Return values
int —Success