Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.67 KB

MarketsApi.md

File metadata and controls

64 lines (44 loc) · 2.67 KB

WsApiClient\MarketsApi

All URIs are relative to https://api.wheel-size.com/v1

Method HTTP request Description
marketsList GET /markets/ Returns a list of markets/regions

marketsList

\WsApiClient\Model\Market[] marketsList($lang)

Returns a list of markets/regions

Get a list of possible markets (regions)

Example

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

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

$apiInstance = new WsApiClient\Api\MarketsApi(
    // 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
);
$lang = "lang_example"; // string | Use this parameter anywhere in the API to get *`name`* field translation of the following objects: **`Make`**, **`Model`**, **`Market`**. Across the *`name`* this objects will have *`name_en`* field with original english name. By default `en` language is used.  Available languages: `en,de,ru,es,pt,fr,ja,zh-cn,zh-tw`. Currently translation works for chinese `zh-cn` language only

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

Parameters

Name Type Description Notes
lang string Use this parameter anywhere in the API to get `name` field translation of the following objects: `Make`, `Model`, `Market`. Across the `name` this objects will have `name_en` field with original english name. By default `en` language is used. Available languages: `en,de,ru,es,pt,fr,ja,zh-cn,zh-tw`. Currently translation works for chinese `zh-cn` language only [optional]

Return type

\WsApiClient\Model\Market[]

Authorization

user_key

HTTP request headers

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

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