Roster
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getByTeamId() : Roster
- Returns a collection of players and coaches for the specified athletic team's ID.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/athletics/teams/{team_id}/roster"
Endpoint URL pattern
Methods
getByTeamId()
Returns a collection of players and coaches for the specified athletic team's ID.
public
getByTeamId(array{team_id: int} $params) : Roster
The team\_id can be retrieved using the GET athletics teams
endpoint.
Requires at least one of the following roles in the Education Management system:
-
Athletic Group Manager
-
Team Schedule Manager
-
Coach
-
Pending Coach
Parameters
- $params : array{team_id: int}
-
An associative array
- team_id: Format - int32. The ID for the team to get the roster for.
Tags
Return values
Roster —Success