Extended
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getByUserId() : UserExtended
- Returns extended user details for the specified ```user\_id```.
- list_() : UserExtendedCollection
- Returns a paginated collection of extended user details, limited to 1000 users per page.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/extended/{user_id}"
Methods
getByUserId()
Returns extended user details for the specified ```user\_id```.
public
getByUserId(array{user_id: int} $params) : UserExtended
Requires the following role in the Education Management system:
- 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
UserExtended —Success
list_()
Returns a paginated collection of extended user details, limited to 1000 users per page.
public
list_(array{base_role_ids: string, marker: int} $params) : UserExtendedCollection
Use the last user's ID as the marker value to return the next
set of results.
Requires the following role in the Education Management system:
- SKY API Data Sync
Parameters
- $params : array{base_role_ids: string, marker: int}
-
An associative array
- base_role_ids: Comma-delimited list of base role IDs to get users for.
- 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
UserExtendedCollection —Success