Highlights
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getByHighlightId() : Highlight
- Returns an athletic game's highlights for the specified ```highlight\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/athletics/highlights/{highlight_id}"
Endpoint URL pattern
Methods
getByHighlightId()
Returns an athletic game's highlights for the specified ```highlight\_id```.
public
getByHighlightId(array{highlight_id: int} $params) : Highlight
This ID can be obtained via the GET athletics schedules endpoint for a game if highlights exist for that game.
Requires at least one of the following roles in the Education Management system:
-
Athletic Group Manager
-
Team Schedule Manager
-
Schedule Manager
-
Page Manager
-
Coach
-
Pending Coach
Parameters
- $params : array{highlight_id: int}
-
An associative array
- highlight_id: Format - int32. ID of the highlight to be returned.
Tags
Return values
Highlight —Success