Athleticrequirements
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getByUserId() : array<string|int, StudentAthleticRequirementRead>
- Returns a collection of medical athletic requirements for a student.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/medical/users/{user_id}/athleticrequirements"
Endpoint URL pattern
Methods
getByUserId()
Returns a collection of medical athletic requirements for a student.
public
getByUserId(array{user_id: int, schoolYear: string, season: string, include_: string} $params) : array<string|int, StudentAthleticRequirementRead>
Requires at least one of the following roles in the Education Management system:
-
Nurse
-
Coach
Parameters
- $params : array{user_id: int, schoolYear: string, season: string, include_: string}
-
An associative array
- user_id: Format - int32. The ID of the student
- schoolYear: The description of the school year
- season: The description of the season
- include_: Show all athletic requirements or only those completed or missing. School year and season are required if not set to completed. Allowed values: all, completed, missing
Tags
Return values
array<string|int, StudentAthleticRequirementRead> —Success