AdministrationApi.md

invoker\AdministrationApi

All URIs are relative to https://localhost/rest

Method	HTTP request	Description
getHealth	GET /v0/admin/health	HTTP GET health
getUser	GET /v0/admin/user	HTTP GET user

getHealth

\model\HealthResponse getHealth()

HTTP GET health

GET server health (OK 200)

Example

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

$api_instance = new invoker\Api\AdministrationApi();

try {
    $result = $api_instance->getHealth();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationApi->getHealth: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\model\HealthResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json; charset=utf-8

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

getUser

\model\UserResponse getUser($accept_language)

HTTP GET user

Get user informations

Example

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

// Configure HTTP basic authorization: basic
invoker\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
invoker\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new invoker\Api\AdministrationApi();
$accept_language = "accept_language_example"; // string | Accept language header

try {
    $result = $api_instance->getUser($accept_language);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
accept_language	string	Accept language header	[optional]

Return type

\model\UserResponse

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json; charset=utf-8

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