Employment
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getByUserId() : FacultyEmploymentRead
- Returns the employment details for the specified ```user\_id```.
- list_() : UserEmploymentCollection
- Returns a paginated collection of users employment details based on base roles, limited to 1000 users per page.
- patchOnUserId() : int
- Updates the employment information for a user.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{user_id}/employment"
Methods
getByUserId()
Returns the employment details for the specified ```user\_id```.
public
getByUserId(array{user_id: int} $params) : FacultyEmploymentRead
Requires at least one of the following roles 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
FacultyEmploymentRead —Success
list_()
Returns a paginated collection of users employment details based on base roles, limited to 1000 users per page.
public
list_(array{base_role_ids: string, marker: int} $params) : UserEmploymentCollection
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
-
SKY API Platform Manager
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
UserEmploymentCollection —Success
patchOnUserId()
Updates the employment information for a user.
public
patchOnUserId(array{user_id: int} $params, UserEmploymentUpdate $requestBody) : int
Requires the following role in the Education Management system:
-
SKY API Data Sync
-
SKY API Platform Manager
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
- $requestBody : UserEmploymentUpdate
Tags
Return values
int —Success