Skip to content

Latest commit

 

History

History
251 lines (178 loc) · 7.28 KB

DefaultApi.md

File metadata and controls

251 lines (178 loc) · 7.28 KB

Swagger\Client\DefaultApi

All URIs are relative to /

Method HTTP request Description
getAppApiConfigurationColorconfig GET /api/config/colors Returns the configured color codes and names
getAppApiConfigurationTimesheetconfig GET /api/config/timesheet Returns the timesheet configuration
getAppApiStatusPing GET /api/ping A testing route for the API
getAppApiStatusPlugin GET /api/plugins Returns information about installed Plugins
getAppApiStatusVersion GET /api/version Returns information about the Kimai release

getAppApiConfigurationColorconfig

map[string,string] getAppApiConfigurationColorconfig()

Returns the configured color codes and names

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


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

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

Parameters

This endpoint does not need any parameter.

Return type

map[string,string]

Authorization

bearer

HTTP request headers

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

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

getAppApiConfigurationTimesheetconfig

\Swagger\Client\Model\TimesheetConfig getAppApiConfigurationTimesheetconfig()

Returns the timesheet configuration

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


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

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

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\TimesheetConfig

Authorization

bearer

HTTP request headers

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

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

getAppApiStatusPing

getAppApiStatusPing()

A testing route for the API

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


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

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

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

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

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

getAppApiStatusPlugin

\Swagger\Client\Model\Plugin[] getAppApiStatusPlugin()

Returns information about installed Plugins

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


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

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

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\Plugin[]

Authorization

bearer

HTTP request headers

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

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

getAppApiStatusVersion

\Swagger\Client\Model\Version getAppApiStatusVersion()

Returns information about the Kimai release

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


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

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

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\Version

Authorization

bearer

HTTP request headers

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

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