Changed
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : EmergencyContactChangeCollection
- Returns a paginated collection of all emergency contacts for all users that have had changes since the specified ```start\_date```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/emergencycontacts/changed"
Endpoint URL pattern
Methods
list_()
Returns a paginated collection of all emergency contacts for all users that have had changes since the specified ```start\_date```.
public
list_(array{start_date: string, marker?: int} $params) : EmergencyContactChangeCollection
If no date is specified then this returns a paginated collection of all emergency contacts for all users.
Use the last user's ID as the marker value to return the next
set of results.
Requires at least one of the following roles in the Education Management system:
- SKY API Data Sync
Parameters
- $params : array{start_date: string, marker?: int}
-
An associative array
- start_date: Format - date-time (as date-time in RFC3339). The date to begin looking for changes. Use ISO-8601 date format: 2022-04-16.
- 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
EmergencyContactChangeCollection —Success