Documentation

Sports extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

list_()  : SportCollection
Returns a collection of athletic sports.

Properties

$url

protected string $url = "https://api.sky.blackbaud.com/school/v1/athletics/sports"

Endpoint URL pattern

Methods

list_()

Returns a collection of athletic sports.

public list_(array{season_id: int} $params) : SportCollection

Use the optional season\_id to filter the results by season.

Requires at least one of the following roles in the Education Management system:

  • Athletic Group Manager

  • Schedule Manager

  • Page Manager

  • Coach

  • Pending Coach

Parameters
$params : array{season_id: int}

An associative array

  • season_id: Format - int32. Season ID
Tags
throws
ArgumentException

if required parameters are not defined

Return values
SportCollection

Success


        
On this page

Search results