UserAccountApi.md

OpenAPI\Client\UserAccountApi

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

Method	HTTP request	Description
userAccountChangePassword()	POST /api/v1/useraccount/changepassword	Change user password
userAccountGet()	GET /api/v1/useraccounts	Retreives list of user accounts
userAccountGetLocalization()	GET /api/v1/useraccount/localization	Get current user localization
userAccountLogout()	GET /api/v1/useraccount/logout	Disconnects from topal server
userAccountProfile()	GET /api/v1/useraccount/profile	Get user profile data
userAccountSaveLocalization()	POST /api/v1/useraccount/localization/{localization}	Change user localization
userAccountSaveProfile()	POST /api/v1/useraccount/profile	Save user profile data

userAccountChangePassword()

userAccountChangePassword($change_password): object

Change user password

Example

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



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

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

Parameters

Name	Type	Description	Notes
change_password	\Topal\Client\Model\ChangePassword

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]

userAccountGet()

userAccountGet(): \Topal\Client\Model\UserAccount[]

Retreives list of user accounts

Example

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



$apiInstance = new Topal\Client\Api\UserAccountApi(
    // 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->userAccountGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserAccountApi->userAccountGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Topal\Client\Model\UserAccount[]

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]

userAccountGetLocalization()

userAccountGetLocalization(): string

Get current user localization

Example

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



$apiInstance = new Topal\Client\Api\UserAccountApi(
    // 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->userAccountGetLocalization();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserAccountApi->userAccountGetLocalization: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

string

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]

userAccountLogout()

userAccountLogout(): object

Disconnects from topal server

Example

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



$apiInstance = new Topal\Client\Api\UserAccountApi(
    // 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->userAccountLogout();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserAccountApi->userAccountLogout: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

object

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]

userAccountProfile()

userAccountProfile(): \Topal\Client\Model\UserAccount

Get user profile data

Example

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



$apiInstance = new Topal\Client\Api\UserAccountApi(
    // 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->userAccountProfile();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserAccountApi->userAccountProfile: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Topal\Client\Model\UserAccount

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]

userAccountSaveLocalization()

userAccountSaveLocalization($localization): string

Change user localization

Example

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



$apiInstance = new Topal\Client\Api\UserAccountApi(
    // 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()
);
$localization = 'localization_example'; // string

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

Parameters

Name	Type	Description	Notes
localization	string

Return type

string

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]

userAccountSaveProfile()

userAccountSaveProfile($user_profile): object

Save user profile data

Example

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



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

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

Parameters

Name	Type	Description	Notes
user_profile	\Topal\Client\Model\UserAccount

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]