Skip to content

Latest commit

 

History

History
155 lines (110 loc) · 5.25 KB

DivisionsApi.md

File metadata and controls

155 lines (110 loc) · 5.25 KB

Verdigado\GrueneApiClient\DivisionsApi

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

Method HTTP request Description
findDivisions() GET /v1/divisions Find divisions
getDivision() GET /v1/divisions/{divisionId} Get division by id

findDivisions()

findDivisions($limit, $offset, $hierarchy, $level, $division_key, $search): \Verdigado\GrueneApiClient\models\FindDivisionsResponse

Find divisions

Example

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


// Configure API key authorization: api_key
$config = Verdigado\GrueneApiClient\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Verdigado\GrueneApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Configure Bearer (JWT) authorization: bearer
$config = Verdigado\GrueneApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure HTTP basic authorization: basic
$config = Verdigado\GrueneApiClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Verdigado\GrueneApiClient\Api\DivisionsApi(
    // 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
);
$limit = 20; // float
$offset = 3.4; // float
$hierarchy = GR; // string | Filter by hierarchy
$level = BV; // string | Filter by hierarchy level
$division_key = array('division_key_example'); // string[] | Filter by division keys
$search = 'search_example'; // string | Search name attributes for substring

try {
    $result = $apiInstance->findDivisions($limit, $offset, $hierarchy, $level, $division_key, $search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DivisionsApi->findDivisions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
limit float [optional] [default to 20]
offset float [optional]
hierarchy string Filter by hierarchy [optional]
level string Filter by hierarchy level [optional]
division_key string[] Filter by division keys [optional]
search string Search name attributes for substring [optional]

Return type

\Verdigado\GrueneApiClient\models\FindDivisionsResponse

Authorization

api_key, bearer, basic

HTTP request headers

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

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

getDivision()

getDivision($division_id): \Verdigado\GrueneApiClient\models\Division

Get division by id

Example

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


// Configure API key authorization: api_key
$config = Verdigado\GrueneApiClient\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Verdigado\GrueneApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

// Configure Bearer (JWT) authorization: bearer
$config = Verdigado\GrueneApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure HTTP basic authorization: basic
$config = Verdigado\GrueneApiClient\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Verdigado\GrueneApiClient\Api\DivisionsApi(
    // 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
);
$division_id = 'division_id_example'; // string

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

Parameters

Name Type Description Notes
division_id string

Return type

\Verdigado\GrueneApiClient\models\Division

Authorization

api_key, bearer, basic

HTTP request headers

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

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