Teams
extends BaseEndpoint
in package
Routing class for the subnamespace `Teams`
Tags
Table of Contents
Properties
- $roster : Roster
- $_roster : Roster|null
- $_schedule : Schedule|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- list_() : TeamCollection
- Returns a collection of athletic teams for the current school year.
Properties
$roster
public
Roster
$roster
$_roster
protected
Roster|null
$_roster
= null
$_roster
$_schedule
protected
Schedule|null
$_schedule
= null
$_schedule Routing class for the subnamespace Schedule
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["roster" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Athletics\\Teams\\Roster", "schedule" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Athletics\\Teams\\Schedule"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/athletics/teams"
Endpoint URL pattern
Methods
list_()
Returns a collection of athletic teams for the current school year.
public
list_(array{school_year: string} $params) : TeamCollection
Use the optional school\_year parameter to specify a different
year.
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{school_year: string}
-
An associative array
- school_year: School year
Tags
Return values
TeamCollection —Success