Addresses
extends BaseEndpoint
in package
Routing class for the subnamespace `Addresses`
Table of Contents
Properties
Methods
- deleteByUserIdAndAddressIdAndAddressTypeId() : mixed
- Removes the specified address from the user.
- patchOnUserIdAndAddressId() : int
- Returns ID of the address just updated.
- postToUserId() : int
- Returns the ID of the address just created.
- searchByUserId() : AddressReadCollection
- Returns a collection of addresses.
Properties
$share
public
Share
$share
$_share
protected
Share|null
$_share
= null
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["share" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Users\\Addresses\\Share"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{user_id}/addresses/{address_id}/{address_type_id}"
Methods
deleteByUserIdAndAddressIdAndAddressTypeId()
Removes the specified address from the user.
public
deleteByUserIdAndAddressIdAndAddressTypeId(array{user_id: int, address_id: int, address_type_id: int} $params) : mixed
If the address is shared, other users linked to the address 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, address_id: int, address_type_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user
- address_id: Format - int32. The ID of the user's address to delete.
- address_type_id: Format - int32. The ID of the user's address type to delete.
Tags
Return values
mixed —Returned when the operation succeeds.
patchOnUserIdAndAddressId()
Returns ID of the address just updated.
public
patchOnUserIdAndAddressId(array{user_id: int, address_id: int} $params, AddressPatch $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, address_id: int}
-
An associative array
- user_id: Format - int32. The ID of the user.
- address_id: Format - int32. The ID of the address to be updated.
- $requestBody : AddressPatch
-
Address information to be updated.
Tags
Return values
int —ID of the address just updated.
postToUserId()
Returns the ID of the address just created.
public
postToUserId(array{user_id: int} $params, AddressAdd $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 : AddressAdd
-
Address information to be updated.
Tags
Return values
int —ID of the address just added.
searchByUserId()
Returns a collection of addresses.
public
searchByUserId(array{user_id: int} $params) : AddressReadCollection
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
AddressReadCollection —Success