Classes
extends BaseEndpoint
in package
Routing class for the subnamespace `Classes`
Table of Contents
Properties
- $categories : Categories
- $lineItems : LineItems
- $results : Results
- $students : Students
- $teachers : Teachers
- $_categories : Categories|null
- $_lineItems : LineItems|null
- $_results : Results|null
- $_students : Students|null
- $_teachers : Teachers|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- get() : ClassesOutputModel
- Returns a collection of classes.
- getById() : ClassOutputModel
- Returns a specific class.
Properties
$categories
public
Categories
$categories
$lineItems
public
LineItems
$lineItems
Routing class for the subnamespace LineItems
$results
public
Results
$results
$students
public
Students
$students
Routing class for the subnamespace Students
$teachers
public
Teachers
$teachers
$_categories
protected
Categories|null
$_categories
= null
$_categories
$_lineItems
protected
LineItems|null
$_lineItems
= null
Routing class for the subnamespace LineItems
$_results
protected
Results|null
$_results
= null
$_students
protected
Students|null
$_students
= null
Routing class for the subnamespace Students
$_teachers
protected
Teachers|null
$_teachers
= null
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["lineItems" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Classes\\LineItems", "results" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Classes\\Results", "teachers" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Classes\\Teachers", "students" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Classes\\Students", "categories" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Classes\\Categories"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/classes/{id}"
Methods
get()
Returns a collection of classes.
public
get() : ClassesOutputModel
Return values
ClassesOutputModel —OK - It was possible to read the collection.
getById()
Returns a specific class.
public
getById(array{id: string} $params) : ClassOutputModel
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the class
Tags
Return values
ClassOutputModel —OK - It was possible to read the resource.