Emergencycontacts
extends BaseEndpoint
in package
Routing class for the subnamespace `Emergencycontacts`
Tags
Table of Contents
Properties
- $_changed : Changed|null
- $_nonuser : Nonuser|null
- $_user : User|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- getByUserId() : EmergencyContactList
- Returns a collection of emergency contacts for the specified ```user\_id```. Requires at least one of the following roles in the Education Management system:
Properties
$_changed
protected
Changed|null
$_changed
= null
$_changed
$_nonuser
protected
Nonuser|null
$_nonuser
= null
$_nonuser
$_user
protected
User|null
$_user
= null
$_user
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["changed" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Users\\Emergencycontacts\\Changed", "user" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Users\\Emergencycontacts\\User", "nonuser" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Users\\Emergencycontacts\\Nonuser"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{user_id}/emergencycontacts"
Endpoint URL pattern
Methods
getByUserId()
Returns a collection of emergency contacts for the specified ```user\_id```. Requires at least one of the following roles in the Education Management system:
public
getByUserId(array{user_id: int} $params) : EmergencyContactList
- SKY API Data Sync
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
Tags
Return values
EmergencyContactList —Success