Departments
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : DepartmentCollection
- Returns a collection of academic departments.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/departments"
Endpoint URL pattern
Methods
list_()
Returns a collection of academic departments.
public
list_(array{level_id: int, include_nonacademic: bool} $params) : DepartmentCollection
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Platform Manager
-
Any Manager Role
Parameters
- $params : array{level_id: int, include_nonacademic: bool}
-
An associative array
- level_id: Format - int32. Provide a school level ID to limit results to departments valid for the specified school level.
- include_nonacademic: Set to true to include non-academic departments in results. Defaults to false.
Tags
Return values
DepartmentCollection —Success