Audit
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : UserAuditReadCollection
- Returns a collection of audit information based on the specified ```role\_id``` within the dates provided.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/audit"
Endpoint URL pattern
Methods
list_()
Returns a collection of audit information based on the specified ```role\_id``` within the dates provided.
public
list_(array{role_id: string, start_date: string, end_date: string} $params) : UserAuditReadCollection
Requires at least one of the following roles in the Education Management system:
- SKY API Data Sync
Parameters
- $params : array{role_id: string, start_date: string, end_date: string}
-
An associative array
- role_id: Role to return audit information for.
- start_date: Format - date-time (as date-time in RFC3339). The date to begin looking for changes. Must be greater than 01/01/1990.
- end_date: Format - date-time (as date-time in RFC3339). The date to end looking for changes. Must be within 1 year of start_date. Null returns start_date + 7 days.
Tags
Return values
UserAuditReadCollection —Success