Skip to content

TransferApi.md

Latest commit

 

History

History
175 lines (125 loc) · 6.29 KB

TransferApi.md

File metadata and controls

175 lines (125 loc) · 6.29 KB

Bluerain\ID4iClient\TransferApi

All URIs are relative to https://backend.id4i.de

Method HTTP request Description
getSendInfo GET /api/v1/transfers/{id4n}/sendInfo Show transfer preparation information
prepare PUT /api/v1/transfers/{id4n}/sendInfo Prepare an object for transfer
receive PUT /api/v1/transfers/{id4n}/receiveInfo Transfer a GUID or collection, obtaining it (i.e. becoming the holder) and if allowed also taking ownership

getSendInfo

\Bluerain\ID4iClient\Model\TransferSendInfo getSendInfo($id4n)

Show transfer preparation information

Example

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

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

$apiInstance = new Bluerain\ID4iClient\Api\TransferApi(
    // 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
);
$id4n = "id4n_example"; // string | The ID4N to retrieve information about

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

Parameters

Name Type Description Notes
id4n string The ID4N to retrieve information about

Return type

\Bluerain\ID4iClient\Model\TransferSendInfo

Authorization

Authorization

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

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

prepare

object prepare($id4n, $request)

Prepare an object for transfer

Example

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

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

$apiInstance = new Bluerain\ID4iClient\Api\TransferApi(
    // 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
);
$id4n = "id4n_example"; // string | The ID4N to prepare for transfer
$request = new \Bluerain\ID4iClient\Model\TransferSendInfo(); // \Bluerain\ID4iClient\Model\TransferSendInfo | Transfer preparation status

try {
    $result = $apiInstance->prepare($id4n, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransferApi->prepare: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id4n string The ID4N to prepare for transfer
request \Bluerain\ID4iClient\Model\TransferSendInfo Transfer preparation status

Return type

object

Authorization

Authorization

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

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

receive

receive($id4n, $request)

Transfer a GUID or collection, obtaining it (i.e. becoming the holder) and if allowed also taking ownership

Taking ownership can be forbidden by a previous owner. See methods prepare and getInfo

Example

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

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

$apiInstance = new Bluerain\ID4iClient\Api\TransferApi(
    // 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
);
$id4n = "id4n_example"; // string | This ID4N identifies the object to take hold of
$request = new \Bluerain\ID4iClient\Model\TransferReceiveInfo(); // \Bluerain\ID4iClient\Model\TransferReceiveInfo | Required information to receive an id4n object

try {
    $apiInstance->receive($id4n, $request);
} catch (Exception $e) {
    echo 'Exception when calling TransferApi->receive: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id4n string This ID4N identifies the object to take hold of
request \Bluerain\ID4iClient\Model\TransferReceiveInfo Required information to receive an id4n object

Return type

void (empty response body)

Authorization

Authorization

HTTP request headers

  • Content-Type: application/xml, application/json
  • Accept: application/xml, application/json

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