Skip to content

Latest commit

 

History

History
169 lines (112 loc) · 4.18 KB

LoginAndLogoutApi.md

File metadata and controls

169 lines (112 loc) · 4.18 KB

OpenAPI\Client\LoginAndLogoutApi

All URIs are relative to https://api.wall.et, except if the operation defines another base path.

Method HTTP request Description
login() POST /authentication/login Login
loginStatus() GET /authentication/status/{token} Retrieve status of session token
logout() DELETE /authentication/logout Logout

login()

login($wt_authentication_login_request): \OpenAPI\Client\Model\WTAuthenticationLoginResponse

Login

Example

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



$apiInstance = new OpenAPI\Client\Api\LoginAndLogoutApi(
    // 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()
);
$wt_authentication_login_request = new \OpenAPI\Client\Model\WTAuthenticationLoginRequest(); // \OpenAPI\Client\Model\WTAuthenticationLoginRequest

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

Parameters

Name Type Description Notes
wt_authentication_login_request \OpenAPI\Client\Model\WTAuthenticationLoginRequest

Return type

\OpenAPI\Client\Model\WTAuthenticationLoginResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

loginStatus()

loginStatus($token): \OpenAPI\Client\Model\LoginStatus200Response

Retrieve status of session token

Example

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



$apiInstance = new OpenAPI\Client\Api\LoginAndLogoutApi(
    // 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()
);
$token = 'token_example'; // string

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

Parameters

Name Type Description Notes
token string

Return type

\OpenAPI\Client\Model\LoginStatus200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

logout()

logout(): string

Logout

Example

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



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

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