Changed
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : UserExtendedCollection
- Returns a paginated collection of users that have been created or modified within the specified timeframe. The timeframe is from the start\_date to the start\_date plus seven days.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/changed"
Endpoint URL pattern
Methods
list_()
Returns a paginated collection of users that have been created or modified within the specified timeframe. The timeframe is from the start\_date to the start\_date plus seven days.
public
list_(array{base_role_ids: string, start_date: string} $params) : UserExtendedCollection
Requires the following role in the Education Management system:
- SKY API Data Sync
Parameters
- $params : array{base_role_ids: string, start_date: string}
-
An associative array
- base_role_ids: Comma-delimited list of base role IDs to get users for.
- start_date: Format - date-time (as date-time in RFC3339). The date to begin looking for changes. Use ISO-8601 date format: 2003-04-21.
Tags
Return values
UserExtendedCollection —Success