Education
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- deleteByUserIdAndEducationId() : mixed
- Deletes an education entry for a user.
- patchOnUserIdAndEducationId() : int
- Updates an education entry for a user.
- postToUserId() : int
- Creates an education entry for a user.
- searchByUserId() : EducationReadCollection
- Returns a collection of education information for the specified ```user\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{user_id}/education/{education_id}"
Methods
deleteByUserIdAndEducationId()
Deletes an education entry for a user.
public
deleteByUserIdAndEducationId(array{user_id: int, education_id: int} $params) : mixed
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, education_id: int}
-
An associative array
- user_id: Format - int32.
- education_id: Format - int32.
Tags
Return values
mixed —Success
patchOnUserIdAndEducationId()
Updates an education entry for a user.
public
patchOnUserIdAndEducationId(array{user_id: int, education_id: int} $params, EducationUpdate $requestBody) : 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, education_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
- education_id: Format - int32. The ID of the education.
- $requestBody : EducationUpdate
-
The education model.
Tags
Return values
int —Success
postToUserId()
Creates an education entry for a user.
public
postToUserId(array{user_id: int} $params, EducationAdd $requestBody) : 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}
-
An associative array
- user_id: Format - int32. The ID of the user.
- $requestBody : EducationAdd
-
The education model.
Tags
Return values
int —Success
searchByUserId()
Returns a collection of education information for the specified ```user\_id```.
public
searchByUserId(array{user_id: int} $params) : EducationReadCollection
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
EducationReadCollection —Success