Enrollments
extends BaseEndpoint
in package
Routing class for the subnamespace `Enrollments`
Tags
Table of Contents
Properties
- $_changes : Changes|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- searchByUserId() : EnrollmentCollection
- Returns a collection of course sections in which the provided student is enrolled.
Properties
$_changes
protected
Changes|null
$_changes
= null
$_changes
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["changes" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Academics\\Enrollments\\Changes"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/enrollments/{user_id}"
Endpoint URL pattern
Methods
searchByUserId()
Returns a collection of course sections in which the provided student is enrolled.
public
searchByUserId(array{user_id: int, school_year: string} $params) : EnrollmentCollection
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Schedule Manager
Parameters
- $params : array{user_id: int, school_year: string}
-
An associative array
- user_id: Format - int32. User identifier.
- school_year: The school year to filter the collection of sections
by. Corresponds to
school\_year\_labelin the Year list. Defaults to the current school year.
Tags
Return values
EnrollmentCollection —Success