Practice
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- deleteByTeamIdAndPracticeId() : mixed
- Removes the athletic ```practice\_id``` for the specified ```team\_id```.
- patchOnTeamId() : mixed
- Updates the practice data for the specified athletic practice ```id```.
- postToTeamId() : int
- Creates a new athletic practice for the specified ```team\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/athletics/teams/{team_id}/schedule/practice/{practice_id}"
Methods
deleteByTeamIdAndPracticeId()
Removes the athletic ```practice\_id``` for the specified ```team\_id```.
public
deleteByTeamIdAndPracticeId(array{team_id: int, practice_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, practice_id: int}
-
An associative array
- team_id: Format - int32. ID of the team for the practice to be deleted
- practice_id: Format - int32. ID of the practice to be deleted
Tags
Return values
mixed —Success
patchOnTeamId()
Updates the practice data for the specified athletic practice ```id```.
public
patchOnTeamId(array{team_id: int} $params, PracticeUpdate $requestBody) : mixed
Requires at least one of the following roles in the Education Management system:
- Athletic Group Manager
Parameters
- $params : array{team_id: int}
-
An associative array
- team_id: Format - int32. The ID of the team for the practice to be updated
- $requestBody : PracticeUpdate
-
Information about the practice to be updated
Tags
Return values
mixed —Success
postToTeamId()
Creates a new athletic practice for the specified ```team\_id```.
public
postToTeamId(array{team_id: int} $params, PracticeCreate $requestBody) : int
Requires at least one of the following roles in the Education Management system:
-
Team Schedule Manager
-
Page Manager
Parameters
- $params : array{team_id: int}
-
An associative array
- team_id: Format - int32. ID of the team for the practice to be created
- $requestBody : PracticeCreate
-
Information about the practice to be created
Tags
Return values
int —Success