Schools
extends BaseEndpoint
in package
Routing class for the subnamespace `Schools`
Tags
Table of Contents
Properties
- $classes : Classes
- $courses : Courses
- $students : Students
- $teachers : Teachers
- $terms : Terms
- $_classes : Classes|null
- $_courses : Courses|null
- $_enrollments : Enrollments|null
- $_students : Students|null
- $_teachers : Teachers|null
- $_terms : Terms|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- get() : OrgsOutputModel
- Returns a collection of schools.
- getById() : OrgOutputModel
- Returns a specific school.
Properties
$classes
public
Classes
$classes
Routing class for the subnamespace Classes
$courses
public
Courses
$courses
$students
public
Students
$students
$teachers
public
Teachers
$teachers
$terms
public
Terms
$terms
$_classes
protected
Classes|null
$_classes
= null
Routing class for the subnamespace Classes
$_courses
protected
Courses|null
$_courses
= null
$_enrollments
protected
Enrollments|null
$_enrollments
= null
$_enrollments
$_students
protected
Students|null
$_students
= null
$_teachers
protected
Teachers|null
$_teachers
= null
$_terms
protected
Terms|null
$_terms
= null
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["classes" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Schools\\Classes", "teachers" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Schools\\Teachers", "students" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Schools\\Students", "enrollments" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Schools\\Enrollments", "terms" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Schools\\Terms", "courses" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Schools\\Courses"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/schools/{id}"
Methods
get()
Returns a collection of schools.
public
get() : OrgsOutputModel
Return values
OrgsOutputModel —OK - It was possible to read the collection.
getById()
Returns a specific school.
public
getById(array{id: string} $params) : OrgOutputModel
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the school
Tags
Return values
OrgOutputModel —OK - It was possible to read the resource.