Directories
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : DirectoryModelCollection
- Returns a collection of directories the logged in user has access to Requires at least one of the following roles in the Education Management System:
- searchByDirectoryId() : DirectoryResultCollection
- Returns a collection of directory results the logged in user has access to
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/directories/{directory_id}"
Methods
list_()
Returns a collection of directories the logged in user has access to Requires at least one of the following roles in the Education Management System:
public
list_() : DirectoryModelCollection
-
Parent
-
Faculty
-
Student
Return values
DirectoryModelCollection —Success
searchByDirectoryId()
Returns a collection of directory results the logged in user has access to
public
searchByDirectoryId(array{directory_id: int, search: string, search_all?: bool} $params) : DirectoryResultCollection
search is an optional search string to filter directory results.
search\_all allows the search string to be used for all fields.
When set to false, only searches name fields. defaults to
true.
Requires at least one of the following roles in the Education Management System:
-
Parent
-
Faculty
-
Student
Parameters
- $params : array{directory_id: int, search: string, search_all?: bool}
-
An associative array
- directory_id: Format - int32.
- search:
- search_all:
Tags
Return values
DirectoryResultCollection —Success