Phones
extends BaseEndpoint
in package
Routing class for the subnamespace `Phones`
Table of Contents
Properties
Methods
- deleteByUserIdAndPhoneIdAndPhoneTypeId() : mixed
- Removes the specified phone from the user.
- patchOnUserIdAndPhoneId() : int
- Updates an exising phone record for the specified ```user\_id```.
- postToUserId() : int
- Creates a new phone record for the specified ```user\_id```.
- searchByUserId() : PhoneReadCollection
- Returns a collection phone numbers for the specified ```user\_id```.
Properties
$share
public
Share
$share
$_share
protected
Share|null
$_share
= null
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["share" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Users\\Phones\\Share"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{user_id}/phones/{phone_id}/{phone_type_id}"
Methods
deleteByUserIdAndPhoneIdAndPhoneTypeId()
Removes the specified phone from the user.
public
deleteByUserIdAndPhoneIdAndPhoneTypeId(array{user_id: int, phone_id: int, phone_type_id: int} $params) : mixed
If the phone is shared, other users linked to the phone will not be affected.
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, phone_id: int, phone_type_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
- phone_id: Format - int32. The ID of the user's phone to delete.
- phone_type_id: Format - int32. The ID of the phone type.
Tags
Return values
mixed —Success
patchOnUserIdAndPhoneId()
Updates an exising phone record for the specified ```user\_id```.
public
patchOnUserIdAndPhoneId(array{user_id: int, phone_id: int, split_phone_if_shared?: bool} $params, PhoneUpdate $requestBody) : int
Returns the ID of the phone number updated.
Parameters
- $params : array{user_id: int, phone_id: int, split_phone_if_shared?: bool}
-
An associative array
- user_id: Format - int32. The ID of the user.
- phone_id: Format - int32. The phone id to be updated.
- split_phone_if_shared: Set to true if phone number is shared
- $requestBody : PhoneUpdate
-
The phone information to be updated.
Tags
Return values
int —ID of the phone just updated.
postToUserId()
Creates a new phone record for the specified ```user\_id```.
public
postToUserId(array{user_id: int} $params, PhoneAdd $requestBody) : int
Returns the ID of the phone number 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 : PhoneAdd
-
The phone information to be created.
Tags
Return values
int —ID of the phone just added.
searchByUserId()
Returns a collection phone numbers for the specified ```user\_id```.
public
searchByUserId(array{user_id: int} $params) : PhoneReadCollection
Parameters
- $params : array{user_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
Tags
Return values
PhoneReadCollection —Success