Orgs
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- get() : OrgsOutputModel
- Returns a collection of organizations.
- getById() : OrgOutputModel
- Returns a specific org.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/orgs/{id}"
Methods
get()
Returns a collection of organizations.
public
get() : OrgsOutputModel
Return values
OrgsOutputModel —OK - It was possible to read the collection.
getById()
Returns a specific org.
public
getById(array{id: string} $params) : OrgOutputModel
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the org
Tags
Return values
OrgOutputModel —OK - It was possible to read the resource.