Documentation

Users extends BaseEndpoint

in package

• Application

Routing class for the subnamespace `Users`

Tags

@property

\Blackbaud\SKY\School\Endpoints\V1\Users\Relationships $relationships

@property

\Blackbaud\SKY\School\Endpoints\V1\Users\Emergencycontacts $emergencycontacts Routing class for the subnamespace Emergencycontacts

@property

\Blackbaud\SKY\School\Endpoints\V1\Users\Addresstypes $addresstypes

@property

\Blackbaud\SKY\School\Endpoints\V1\Users\Customfields $customfields Routing class for the subnamespace Customfields

Table of Contents

Properties

$addresses  : Addresses

$audit  : Audit

$bbidstatus  : Bbidstatus

$changed  : Changed

$education  : Education

$employment  : Employment

$enroll  : Enroll

$enrollments  : Enrollments

$extended  : Extended

$gendertypes  : Gendertypes

$me  : Me

$occupations  : Occupations

$phones  : Phones

$phonetypes  : Phonetypes

$students  : Students

$_addresses  : Addresses|null

$_addresstypes  : Addresstypes|null

$_audit  : Audit|null

$_bbidstatus  : Bbidstatus|null

$_changed  : Changed|null

$_customfields  : Customfields|null

$_education  : Education|null

$_emergencycontacts  : Emergencycontacts|null

$_employment  : Employment|null

$_enroll  : Enroll|null

$_enrollments  : Enrollments|null

$_extended  : Extended|null

$_gendertypes  : Gendertypes|null

$_me  : Me|null

$_occupations  : Occupations|null

$_phones  : Phones|null

$_phonetypes  : Phonetypes|null

$_relationships  : Relationships|null

$_students  : Students|null

$endpoints  : array<string, BaseEndpoint>>

$url  : string

Methods

getByUserId()  : UserRead

Returns data for the specified ```user\_id```.

list_()  : UserReadCollection

Returns a paginated collection of users, limited to 100 users per page.

patch()  : int

Updates the record of a single user. **Note:** Deleting/clearing data from a field requires the use of the ```fields\_to\_delete``` property described below

post()  : int

Creates a new user record.