Checklists
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : AdmissionsCheckListCollection
- Returns a collection of admissions checklists.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/admissions/checklists"
Endpoint URL pattern
Methods
list_()
Returns a collection of admissions checklists.
public
list_(array{search_text: string, inactive: bool} $params) : AdmissionsCheckListCollection
Use the optional search\_text to apply a case-insensitive search
against check lists "name".
Use the optional inactive to return only inactive checklists
(default is both).
Requires the following role in the Education Management system:
- Admissions Manager
Parameters
- $params : array{search_text: string, inactive: bool}
-
An associative array
- search_text: Applies a case-insensitive search against check lists "name".
- inactive: flag to return only inactive checklists (default is both).
Tags
Return values
AdmissionsCheckListCollection —Success