Relationships
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- deleteByUserId() : mixed
- Removes a relationship record from the specified ```user\_id```.
- patchOnUserIdAndLeftUserId() : mixed
- Updates a relationship record for the specified ```user\_id```.
- postToUserId() : mixed
- Creates a relationship record for the specified ```user\_id```.
- searchByUserId() : RelationshipReadCollection
- Returns a collection of a relationships for the specified ```user\_id```. Requires at least one of the following roles in the Education Management system:
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{user_id}/relationships/{left_user_id}"
Methods
deleteByUserId()
Removes a relationship record from the specified ```user\_id```.
public
deleteByUserId(array<string|int, mixed> $params) : mixed
If the related individual is also a user, the user profile of that user is preserved. Individuals may need to review or update their emergency contacts. Requires at least one of the following roles in the Education Management system:
-
Payment Services Manager
-
Integration Manager
-
Contact Card Manager
-
Platform Manager
Parameters
- $params : array<string|int, mixed>
Tags
Return values
mixed —Success
patchOnUserIdAndLeftUserId()
Updates a relationship record for the specified ```user\_id```.
public
patchOnUserIdAndLeftUserId(array{user_id: int, left_user_id: int} $params, RelationshipUpdate $requestBody) : mixed
Returns 200 OK Requires at least one of the following roles in the Education Management system:
-
Contact Card Manager
-
Platform Manager
Parameters
- $params : array{user_id: int, left_user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
- left_user_id: Format - int32. The user ID of the relationship to the user
- $requestBody : RelationshipUpdate
-
Defines the relationship to be updated.
Tags
Return values
mixed —Success
postToUserId()
Creates a relationship record for the specified ```user\_id```.
public
postToUserId(array{user_id: int} $params, RelationshipCreate $requestBody) : mixed
This doesn't create a user profile for the related individual.
Returns 200 OK Requires at least one of the following roles in the Education Management system:
-
Payment Services Manager
-
Integration Manager
-
Contact Card Manager
-
Platform Manager
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
- $requestBody : RelationshipCreate
-
Defines the relationship to be created.
Tags
Return values
mixed —Success
searchByUserId()
Returns a collection of a relationships for the specified ```user\_id```. Requires at least one of the following roles in the Education Management system:
public
searchByUserId(array{user_id: int} $params) : RelationshipReadCollection
-
Payment Services Manager
-
Integration Manager
-
Contact Card Manager
-
Platform Manager
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
Tags
Return values
RelationshipReadCollection —Success