Occupations
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- deleteByUserIdAndOccupationId() : int
- Deletes an occupation entry for a user.
- patchOnUserIdAndOccupationId() : int
- Updates an occupation entry for a user.
- postToUserId() : int
- Creates an occupation record for the specified ```user\_id```.
- searchByUserId() : OccupationReadCollection
- Returns a collection of occupations for the specified ```user\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{user_id}/occupations/{occupation_id}"
Methods
deleteByUserIdAndOccupationId()
Deletes an occupation entry for a user.
public
deleteByUserIdAndOccupationId(array{user_id: int, occupation_id: int, current: bool} $params) : int
Requires at least one of the following roles in the Education Management system:
-
SKY API Data Sync
-
Platform Manager
-
Contact Card Manager
Parameters
- $params : array{user_id: int, occupation_id: int, current: bool}
-
An associative array
- user_id: Format - int32. The ID of the user.
- occupation_id: Format - int32. The ID of the occupation.
- current: Current Employment Status
Tags
Return values
int —Success
patchOnUserIdAndOccupationId()
Updates an occupation entry for a user.
public
patchOnUserIdAndOccupationId(array{user_id: int, occupation_id: int} $params, OccupationUpdate $requestBody) : int
Returns the ID of the occupation updated.
Requires at least one of the following roles in the Education Management system:
-
SKY API Data Sync
-
Platform Manager
-
Contact Card Manager
Parameters
- $params : array{user_id: int, occupation_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
- occupation_id: Format - int32. The ID of the occupation.
- $requestBody : OccupationUpdate
-
The occupation information to be updated.
Tags
Return values
int —Success
postToUserId()
Creates an occupation record for the specified ```user\_id```.
public
postToUserId(array{user_id: int} $params, OccupationCreate $requestBody) : int
Returns the ID of the occupation created.
Requires at least one of the following roles in the Education Management system:
-
SKY API Data Sync
-
Platform Manager
-
Contact Card Manager
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
- $requestBody : OccupationCreate
-
The occupation information to be created.
Tags
Return values
int —Success
searchByUserId()
Returns a collection of occupations for the specified ```user\_id```.
public
searchByUserId(array{user_id: int} $params) : OccupationReadCollection
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
OccupationReadCollection —Success