Skip to content

RoutingApi.md

Latest commit

 

History

History
241 lines (177 loc) · 8.54 KB

RoutingApi.md

File metadata and controls

241 lines (177 loc) · 8.54 KB

Bluerain\ID4iClient\RoutingApi

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

Method HTTP request Description
getAllRoutes GET /api/v1/routingfiles/{id4n}/routes/{type} Retrieve all routes of a GUID (or ID4N)
getRoute GET /api/v1/routingfiles/{id4n}/route/{type} Retrieve current route of a GUID (or ID4N)
getRoutingFile GET /api/v1/routingfiles/{id4n} Retrieve routing file
updateRoutingFile PUT /api/v1/routingfiles/{id4n} Store routing file

getAllRoutes

\Bluerain\ID4iClient\Model\Route[] getAllRoutes($id4n, $type, $organization_id, $interpolate)

Retrieve all routes of a GUID (or ID4N)

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\RoutingApi(
    // 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 | id4n
$type = "type_example"; // string | The type of route you want to have
$organization_id = "organization_id_example"; // string | organizationId
$interpolate = true; // bool | interpolate

try {
    $result = $apiInstance->getAllRoutes($id4n, $type, $organization_id, $interpolate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->getAllRoutes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id4n string id4n
type string The type of route you want to have
organization_id string organizationId [optional]
interpolate bool interpolate [optional] [default to true]

Return type

\Bluerain\ID4iClient\Model\Route[]

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]

getRoute

\Bluerain\ID4iClient\Model\Route getRoute($id4n, $type, $private_routes, $public_routes, $interpolate)

Retrieve current route of a GUID (or ID4N)

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\RoutingApi(
    // 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 | id4n
$type = "type_example"; // string | The type of route you want to have
$private_routes = true; // bool | privateRoutes
$public_routes = true; // bool | publicRoutes
$interpolate = true; // bool | interpolate

try {
    $result = $apiInstance->getRoute($id4n, $type, $private_routes, $public_routes, $interpolate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->getRoute: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id4n string id4n
type string The type of route you want to have
private_routes bool privateRoutes [optional] [default to true]
public_routes bool publicRoutes [optional] [default to true]
interpolate bool interpolate [optional] [default to true]

Return type

\Bluerain\ID4iClient\Model\Route

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]

getRoutingFile

\Bluerain\ID4iClient\Model\RoutingFile getRoutingFile($id4n, $organization_id)

Retrieve routing file

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\RoutingApi(
    // 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 | id4n
$organization_id = "organization_id_example"; // string | organizationId

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

Parameters

Name Type Description Notes
id4n string id4n
organization_id string organizationId [optional]

Return type

\Bluerain\ID4iClient\Model\RoutingFile

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]

updateRoutingFile

updateRoutingFile($rfr, $id4n)

Store routing file

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\RoutingApi(
    // 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
);
$rfr = new \Bluerain\ID4iClient\Model\RoutingFileRequest(); // \Bluerain\ID4iClient\Model\RoutingFileRequest | rfr
$id4n = "id4n_example"; // string | id4n

try {
    $apiInstance->updateRoutingFile($rfr, $id4n);
} catch (Exception $e) {
    echo 'Exception when calling RoutingApi->updateRoutingFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
rfr \Bluerain\ID4iClient\Model\RoutingFileRequest rfr
id4n string id4n

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]