Terms
extends BaseEndpoint
in package
Routing class for the subnamespace `Terms`
Tags
Table of Contents
Properties
- $_gradingPeriods : GradingPeriods|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- get() : AcademicSessionsOutputModel
- Returns a collection of terms.
- getById() : AcademicSessionOutputModel
- Returns a specific term.
Properties
$_gradingPeriods
protected
GradingPeriods|null
$_gradingPeriods
= null
$_gradingPeriods
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["gradingPeriods" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Terms\\GradingPeriods"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/terms/{id}"
Methods
get()
Returns a collection of terms.
public
get() : AcademicSessionsOutputModel
Return values
AcademicSessionsOutputModel —OK - It was possible to read the collection.
getById()
Returns a specific term.
public
getById(array{id: string} $params) : AcademicSessionOutputModel
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the term
Tags
Return values
AcademicSessionOutputModel —OK - It was possible to read the collection.