BurgerDigital\BlackbaudPhpSdk\AliasApi

All URIs are relative to https://api.sky.blackbaud.com/constituent/v1.

Method	HTTP request	Description
createConstituentAlias()	POST /aliases	Alias (Create)
deleteConstituentAlias()	DELETE /aliases/{alias_id}	Alias (Delete)
editConstituentAlias()	PATCH /aliases/{alias_id}	Alias (Edit)
listAliasTypes()	GET /aliastypes	Alias types
listConstituentAliasesSingleConstituent()	GET /constituents/{constituent_id}/aliases	Alias list (Single constituent)

`createConstituentAlias()`

createConstituentAlias($alias_add): \BurgerDigital\BlackbaudPhpSdk\Model\PostResponse

Alias (Create)

Creates an alias.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKeyHeader
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('Bb-Api-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Bb-Api-Subscription-Key', 'Bearer');

// Configure API key authorization: apiKeyQuery
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('subscription-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-key', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceImplicit
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BurgerDigital\BlackbaudPhpSdk\Api\AliasApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$alias_add = new \BurgerDigital\BlackbaudPhpSdk\Model\AliasAdd(); // \BurgerDigital\BlackbaudPhpSdk\Model\AliasAdd | An object that represents the alias to create.

try {
    $result = $apiInstance->createConstituentAlias($alias_add);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AliasApi->createConstituentAlias: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
alias_add	\BurgerDigital\BlackbaudPhpSdk\Model\AliasAdd	An object that represents the alias to create.	[optional]

Return type

\BurgerDigital\BlackbaudPhpSdk\Model\PostResponse

Authorization

apiKeyHeader, apiKeyQuery, [oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode](../../README.md#oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode), [oauth2Blackbaud OAuth 2.0 ServiceImplicit](../../README.md#oauth2Blackbaud OAuth 2.0 ServiceImplicit)

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteConstituentAlias()`

deleteConstituentAlias($alias_id)

Alias (Delete)

Deletes an alias.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKeyHeader
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('Bb-Api-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Bb-Api-Subscription-Key', 'Bearer');

// Configure API key authorization: apiKeyQuery
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('subscription-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-key', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceImplicit
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BurgerDigital\BlackbaudPhpSdk\Api\AliasApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$alias_id = 'alias_id_example'; // string | The immutable system record ID of the alias to delete.

try {
    $apiInstance->deleteConstituentAlias($alias_id);
} catch (Exception $e) {
    echo 'Exception when calling AliasApi->deleteConstituentAlias: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
alias_id	string	The immutable system record ID of the alias to delete.

Return type

void (empty response body)

Authorization

apiKeyHeader, apiKeyQuery, [oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode](../../README.md#oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode), [oauth2Blackbaud OAuth 2.0 ServiceImplicit](../../README.md#oauth2Blackbaud OAuth 2.0 ServiceImplicit)

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`editConstituentAlias()`

editConstituentAlias($alias_id, $alias_edit)

Alias (Edit)

Edits an alias for a constituent.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKeyHeader
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('Bb-Api-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Bb-Api-Subscription-Key', 'Bearer');

// Configure API key authorization: apiKeyQuery
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('subscription-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-key', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceImplicit
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BurgerDigital\BlackbaudPhpSdk\Api\AliasApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$alias_id = 'alias_id_example'; // string | The immutable system record ID of the alias to edit.
$alias_edit = new \BurgerDigital\BlackbaudPhpSdk\Model\AliasEdit(); // \BurgerDigital\BlackbaudPhpSdk\Model\AliasEdit | An object that represents the properties of the alias to edit.

try {
    $apiInstance->editConstituentAlias($alias_id, $alias_edit);
} catch (Exception $e) {
    echo 'Exception when calling AliasApi->editConstituentAlias: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
alias_id	string	The immutable system record ID of the alias to edit.
alias_edit	\BurgerDigital\BlackbaudPhpSdk\Model\AliasEdit	An object that represents the properties of the alias to edit.	[optional]

Return type

void (empty response body)

Authorization

apiKeyHeader, apiKeyQuery, [oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode](../../README.md#oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode), [oauth2Blackbaud OAuth 2.0 ServiceImplicit](../../README.md#oauth2Blackbaud OAuth 2.0 ServiceImplicit)

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listAliasTypes()`

listAliasTypes(): \BurgerDigital\BlackbaudPhpSdk\Model\ApiCollectionString

Alias types

Returns a list of active alias types.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKeyHeader
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('Bb-Api-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Bb-Api-Subscription-Key', 'Bearer');

// Configure API key authorization: apiKeyQuery
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('subscription-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-key', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceImplicit
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BurgerDigital\BlackbaudPhpSdk\Api\AliasApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->listAliasTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AliasApi->listAliasTypes: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\BurgerDigital\BlackbaudPhpSdk\Model\ApiCollectionString

Authorization

apiKeyHeader, apiKeyQuery, [oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode](../../README.md#oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode), [oauth2Blackbaud OAuth 2.0 ServiceImplicit](../../README.md#oauth2Blackbaud OAuth 2.0 ServiceImplicit)

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listConstituentAliasesSingleConstituent()`

listConstituentAliasesSingleConstituent($constituent_id, $limit, $offset): \BurgerDigital\BlackbaudPhpSdk\Model\ApiCollectionAliasRead

Alias list (Single constituent)

Returns a list of aliases for a constituent.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKeyHeader
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('Bb-Api-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Bb-Api-Subscription-Key', 'Bearer');

// Configure API key authorization: apiKeyQuery
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('subscription-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-key', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceImplicit
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BurgerDigital\BlackbaudPhpSdk\Api\AliasApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$constituent_id = 'constituent_id_example'; // string | The immutable system record ID of the constituent to retrieve the aliases for.
$limit = 56; // int | Format - int32. Represents the number of records to return. The default is 500. The maximum is 5000.
$offset = 56; // int | Format - int32. Represents the number of records to skip. For use with pagination.

try {
    $result = $apiInstance->listConstituentAliasesSingleConstituent($constituent_id, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AliasApi->listConstituentAliasesSingleConstituent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
constituent_id	string	The immutable system record ID of the constituent to retrieve the aliases for.
limit	int	Format - int32. Represents the number of records to return. The default is 500. The maximum is 5000.	[optional]
offset	int	Format - int32. Represents the number of records to skip. For use with pagination.	[optional]

Return type

\BurgerDigital\BlackbaudPhpSdk\Model\ApiCollectionAliasRead

Authorization

apiKeyHeader, apiKeyQuery, [oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode](../../README.md#oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode), [oauth2Blackbaud OAuth 2.0 ServiceImplicit](../../README.md#oauth2Blackbaud OAuth 2.0 ServiceImplicit)

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AliasApi.md

AliasApi.md

BurgerDigital\BlackbaudPhpSdk\AliasApi

`createConstituentAlias()`

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteConstituentAlias()`

Example

Parameters

Return type

Authorization

HTTP request headers

`editConstituentAlias()`

Example

Parameters

Return type

Authorization

HTTP request headers

`listAliasTypes()`

Example

Parameters

Return type

Authorization

HTTP request headers

`listConstituentAliasesSingleConstituent()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

AliasApi.md

Latest commit

History

AliasApi.md

File metadata and controls

BurgerDigital\BlackbaudPhpSdk\AliasApi

createConstituentAlias()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteConstituentAlias()

Example

Parameters

Return type

Authorization

HTTP request headers

editConstituentAlias()

Example

Parameters

Return type

Authorization

HTTP request headers

listAliasTypes()

Example

Parameters

Return type

Authorization

HTTP request headers

listConstituentAliasesSingleConstituent()

Example

Parameters

Return type

Authorization

HTTP request headers

`createConstituentAlias()`

`deleteConstituentAlias()`

`editConstituentAlias()`

`listAliasTypes()`

`listConstituentAliasesSingleConstituent()`