Bluerain\ID4iClient\PublicServicesApi

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

Method	HTTP request	Description
getPublicDocument	GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata	Retrieve a public document (meta-data only, no content)
getRoutes	GET /api/v1/public/routes/{id4n}	Retrieve all public routes for a GUID
go	GET /go/{guid}	Forward
listAllPublicDocuments	GET /api/v1/public/documents/{id4n}	List public documents
listPublicHistory	GET /api/v1/public/history/{id4n}	Shows the public history of the given GUID
readOrganizationInfo	GET /api/v1/public/organizations/{organizationId}	Read public organization information
readPublicDocument	GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}	Read public document contents
resolveImageUsingGET	GET /api/v1/public/image/{imageID}	Resolve image
resolveWhoIsEntry	GET /whois/{id4n}	Resolve owner of id4n

getPublicDocument

\Bluerain\ID4iClient\Model\Document getPublicDocument($organization_id, $id4n, $file_name)

Retrieve a public document (meta-data only, no content)

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\PublicServicesApi(
    // 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
);
$organization_id = "organization_id_example"; // string | organizationId
$id4n = "id4n_example"; // string | id4n
$file_name = "file_name_example"; // string | fileName

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

Parameters

Name	Type	Description
organization_id	string	organizationId
id4n	string	id4n
file_name	string	fileName

Return type

\Bluerain\ID4iClient\Model\Document

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]

getRoutes

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

Retrieve all public routes for a GUID

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\PublicServicesApi(
    // 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 = "web"; // string | type
$interpolate = true; // bool | interpolate

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

Parameters

Name	Type	Description	Notes
id4n	string	id4n
type	string	type	[default to web]
interpolate	bool	interpolate	[optional] [default to true]

Return type

\Bluerain\ID4iClient\Model\Route[]

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]

go

go($guid)

Forward

Forwarding to the designated route defined in the routing,

Example

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

$apiInstance = new Bluerain\ID4iClient\Api\PublicServicesApi(
    // 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()
);
$guid = "guid_example"; // string | guid

try {
    $apiInstance->go($guid);
} catch (Exception $e) {
    echo 'Exception when calling PublicServicesApi->go: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
guid	string	guid

Return type

void (empty response body)

Authorization

No authorization required

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]

listAllPublicDocuments

\Bluerain\ID4iClient\Model\PaginatedResponseOfDocument listAllPublicDocuments($id4n, $organization_id, $owner, $offset, $limit)

List public documents

Listing all public documents of an 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\PublicServicesApi(
    // 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
$owner = "owner_example"; // string | Filter by owner organization
$offset = 56; // int | Start with the n-th element
$limit = 56; // int | The maximum count of returned elements

try {
    $result = $apiInstance->listAllPublicDocuments($id4n, $organization_id, $owner, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PublicServicesApi->listAllPublicDocuments: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id4n	string	id4n
organization_id	string	organizationId	[optional]
owner	string	Filter by owner organization	[optional]
offset	int	Start with the n-th element	[optional]
limit	int	The maximum count of returned elements	[optional]

Return type

\Bluerain\ID4iClient\Model\PaginatedResponseOfDocument

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]

listPublicHistory

\Bluerain\ID4iClient\Model\PaginatedResponseOfHistoryItem listPublicHistory($id4n, $offset, $limit)

Shows the public history of the given GUID

Only contains public history items

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\PublicServicesApi(
    // 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 | GUID to retrieve the history for
$offset = 56; // int | Start with the n-th element
$limit = 56; // int | The maximum count of returned elements

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

Parameters

Name	Type	Description	Notes
id4n	string	GUID to retrieve the history for
offset	int	Start with the n-th element	[optional]
limit	int	The maximum count of returned elements	[optional]

Return type

\Bluerain\ID4iClient\Model\PaginatedResponseOfHistoryItem

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]

readOrganizationInfo

\Bluerain\ID4iClient\Model\Organization readOrganizationInfo($organization_id)

Read public organization 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\PublicServicesApi(
    // 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
);
$organization_id = "organization_id_example"; // string | Organization ID

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

Parameters

Name	Type	Description	Notes
organization_id	string	Organization ID

Return type

\Bluerain\ID4iClient\Model\Organization

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]

readPublicDocument

string readPublicDocument($organization_id, $id4n, $file_name)

Read public document contents

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\PublicServicesApi(
    // 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
);
$organization_id = "organization_id_example"; // string | organizationId
$id4n = "id4n_example"; // string | id4n
$file_name = "file_name_example"; // string | fileName

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

Parameters

Name	Type	Description
organization_id	string	organizationId
id4n	string	id4n
file_name	string	fileName

Return type

string

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]

resolveImageUsingGET

string resolveImageUsingGET($image_id)

Resolve image

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\PublicServicesApi(
    // 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
);
$image_id = "image_id_example"; // string | The id of the image to be resolved.

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

Parameters

Name	Type	Description	Notes
image_id	string	The id of the image to be resolved.

Return type

string

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]

resolveWhoIsEntry

\Bluerain\ID4iClient\Model\WhoIsResponse resolveWhoIsEntry($id4n)

Resolve owner of id4n

Example

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

$apiInstance = new Bluerain\ID4iClient\Api\PublicServicesApi(
    // 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()
);
$id4n = "id4n_example"; // string | id4n

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

Parameters

Name	Type	Description	Notes
id4n	string	id4n

Return type

\Bluerain\ID4iClient\Model\WhoIsResponse

Authorization

No authorization required

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]

FilesExpand file tree

PublicServicesApi.md

Latest commit

History

PublicServicesApi.md

File metadata and controls

Bluerain\ID4iClient\PublicServicesApi

getPublicDocument

Example

Parameters

Return type

Authorization

HTTP request headers

getRoutes

Example

Parameters

Return type

Authorization

HTTP request headers

go

Example

Parameters

Return type

Authorization

HTTP request headers

listAllPublicDocuments

Example

Parameters

Return type

Authorization

HTTP request headers

listPublicHistory

Example

Parameters

Return type

Authorization

HTTP request headers

readOrganizationInfo

Example

Parameters

Return type

Authorization

HTTP request headers

readPublicDocument

Example

Parameters

Return type

Authorization

HTTP request headers

resolveImageUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

resolveWhoIsEntry

Example

Parameters

Return type

Authorization

HTTP request headers