Skip to content

Latest commit

 

History

History
124 lines (84 loc) · 3.82 KB

CountriesApi.md

File metadata and controls

124 lines (84 loc) · 3.82 KB

Swagger\Client\CountriesApi

All URIs are relative to https://de.openlegaldata.io/api

Method HTTP request Description
countriesList GET /countries/
countriesRead GET /countries/{id}/

countriesList

\Swagger\Client\Model\InlineResponse2006 countriesList($code, $limit, $offset)

Example

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

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

$apiInstance = new Swagger\Client\Api\CountriesApi(
    // 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
);
$code = "code_example"; // string | 
$limit = 56; // int | Number of results to return per page.
$offset = 56; // int | The initial index from which to return the results.

try {
    $result = $apiInstance->countriesList($code, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CountriesApi->countriesList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
code string [optional]
limit int Number of results to return per page. [optional]
offset int The initial index from which to return the results. [optional]

Return type

\Swagger\Client\Model\InlineResponse2006

Authorization

api_key

HTTP request headers

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

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

countriesRead

\Swagger\Client\Model\Country countriesRead($id)

Example

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

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

$apiInstance = new Swagger\Client\Api\CountriesApi(
    // 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
);
$id = 56; // int | A unique integer value identifying this country.

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

Parameters

Name Type Description Notes
id int A unique integer value identifying this country.

Return type

\Swagger\Client\Model\Country

Authorization

api_key

HTTP request headers

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

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