All
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : DormCollection
- Requires at least one of the following roles in the Education Management system:
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/dorms/all"
Endpoint URL pattern
Methods
list_()
Requires at least one of the following roles in the Education Management system:
public
list_(array{level_number: int, school_year: string} $params) : DormCollection
-
Dorm Group Manager
-
Dorm Supervisor
-
Pending Dorm Supervisor
Parameters
- $params : array{level_number: int, school_year: string}
-
An associative array
- level_number: Format - int32. Identifier for the school level.
- school_year: Identifier for the school year (Defaults to current school year).
Tags
Return values
DormCollection —Success