Terms
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getBySchoolId() : AcademicSessionsOutputModel
- Returns a collection of terms for the specified ```school\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/schools/{school_id}/terms"
Endpoint URL pattern
Methods
getBySchoolId()
Returns a collection of terms for the specified ```school\_id```.
public
getBySchoolId(array{school_id: string} $params) : AcademicSessionsOutputModel
Parameters
- $params : array{school_id: string}
-
An associative array
- school_id: sourcedId for the school
Tags
Return values
AcademicSessionsOutputModel —OK - It was possible to read the collection.