Lists
extends BaseEndpoint
in package
Routing class for the subnamespace `Lists`
Table of Contents
Properties
- $advanced : Advanced
- $_advanced : Advanced|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- list_() : ListReadCollection
- Returns a list of basic or advanced lists the authorized user has access to
Properties
$advanced
public
Advanced
$advanced
$_advanced
protected
Advanced|null
$_advanced
= null
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["advanced" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Lists\\Advanced"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/lists"
Endpoint URL pattern
Methods
list_()
Returns a list of basic or advanced lists the authorized user has access to
public
list_() : ListReadCollection
Requires the following role in the Education Management system:
-
Page Manager
-
Content Editor
-
Teacher
-
Coach
-
Community Group Manager
-
Mentor Manager
-
Alumni Group Manager
-
Athletic Group Manager
-
Academic Group Manager
-
System Group Manager
-
Content Manager
-
Community Group Owner
-
Dorm Group Manager
-
Activity Group Manager
-
Advisory Group Manager
-
Advisor
-
Dorm Supervisor
-
Activity Leader
-
Pending Teacher
-
Pending Advisor
-
Pending Dorm Supervisor
-
Pending Activity Leader
-
Platform Manager
-
SkyApi Data Sync
Return values
ListReadCollection —Success