Locations
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : LocationCollection
- Returns a collection of athletic locations.
- post() : int
- Creates a new athletic location.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/athletics/locations"
Endpoint URL pattern
Methods
list_()
Returns a collection of athletic locations.
public
list_() : LocationCollection
Requires at least one of the following roles in the Education Management system:
-
Athletic Group Manager
-
Team Schedule Manager
-
Schedule Manager
-
Coach
-
Pending Coach
Return values
LocationCollection —Success
post()
Creates a new athletic location.
public
post(LocationCreateModel $requestBody) : int
The location can optionally be tied to an opponent using the
opponent\_id from the GET opponents endpoint.
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
- $requestBody : LocationCreateModel
-
The location to be created
Tags
Return values
int —Success