ClientsApi.md

OpenAPI\Client\ClientsApi

All URIs are relative to https://topal.vitan.ch:9001, except if the operation defines another base path.

Method	HTTP request	Description
clientsGet()	GET /api/v1/clients	Retreives list of client
clientsGet_0()	GET /api/v1/clients/{id}	Retreives a client with specified unique identifier
clientsPost()	POST /api/v1/clients	Save client
clientsUnprotect()	POST /api/v1/clients/{id}/unprotect	Unprotects client protected by password

clientsGet()

clientsGet(): \Topal\Client\Model\Client[]

Retreives list of client

Example

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



$apiInstance = new Topal\Client\Api\ClientsApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Topal\Client\Model\Client[]

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, application/xml, text/xml

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

clientsGet_0()

clientsGet_0($id): \Topal\Client\Model\Client

Retreives a client with specified unique identifier

Example

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



$apiInstance = new Topal\Client\Api\ClientsApi(
    // 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()
);
$id = 'id_example'; // string | The uniue id of the client to retrieve

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

Parameters

Name	Type	Description	Notes
id	string	The uniue id of the client to retrieve

Return type

\Topal\Client\Model\Client

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, application/xml, text/xml

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

clientsPost()

clientsPost($client): \Topal\Client\Model\Client

Save client

Example

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



$apiInstance = new Topal\Client\Api\ClientsApi(
    // 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()
);
$client = new \Topal\Client\Model\Client(); // \Topal\Client\Model\Client

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

Parameters

Name	Type	Description	Notes
client	\Topal\Client\Model\Client

Return type

\Topal\Client\Model\Client

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

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

clientsUnprotect()

clientsUnprotect($id, $password): object

Unprotects client protected by password

Example

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



$apiInstance = new Topal\Client\Api\ClientsApi(
    // 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()
);
$id = 'id_example'; // string | id of the client to unprotect
$password = 'password_example'; // string | password

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

Parameters

Name	Type	Description	Notes
id	string	id of the client to unprotect
password	string	password

Return type

object

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, application/xml, text/xml

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