Bbidstatus
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : SchoolBbidStatusCollection
- Returns a paginated collection of users education management BBID status, limited to 1000 users per page.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/bbidstatus"
Endpoint URL pattern
Methods
list_()
Returns a paginated collection of users education management BBID status, limited to 1000 users per page.
public
list_(array{base_role_ids: string, marker: int} $params) : SchoolBbidStatusCollection
Use the last user's ID as the marker value to return the next
set of results.
Requires one of the following roles in the Education Management system:
-
SKY API Data Sync
-
Platform Manager
Parameters
- $params : array{base_role_ids: string, marker: int}
-
An associative array
- base_role_ids: Comma-delimited list of base role IDs to get users for.
- marker: Format - int32. The user's ID to start at to return the next batch of data. Results will start with the next user in the result set.
Tags
Return values
SchoolBbidStatusCollection —Success