|
| 1 | +# eZmaxAPI\ObjectCurrencyApi |
| 2 | + |
| 3 | +All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path. |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +| ------------- | ------------- | ------------- | |
| 7 | +| [**currencyGetAutocompleteV2()**](ObjectCurrencyApi.md#currencyGetAutocompleteV2) | **GET** /2/object/currency/getAutocomplete/{sSelector} | Retrieve Currencies and IDs | |
| 8 | + |
| 9 | + |
| 10 | +## `currencyGetAutocompleteV2()` |
| 11 | + |
| 12 | +```php |
| 13 | +currencyGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage): \eZmaxAPI\Model\CurrencyGetAutocompleteV2Response |
| 14 | +``` |
| 15 | + |
| 16 | +Retrieve Currencies and IDs |
| 17 | + |
| 18 | +Get the list of Currency to be used in a dropdown or autocomplete control. |
| 19 | + |
| 20 | +### Example |
| 21 | + |
| 22 | +```php |
| 23 | +<?php |
| 24 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 25 | + |
| 26 | + |
| 27 | +// Configure API key authorization: Authorization |
| 28 | +$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); |
| 29 | +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 30 | +// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); |
| 31 | + |
| 32 | + |
| 33 | +$apiInstance = new eZmaxAPI\Api\ObjectCurrencyApi( |
| 34 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 35 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 36 | + new GuzzleHttp\Client(), |
| 37 | + $config |
| 38 | +); |
| 39 | +$sSelector = 'sSelector_example'; // string | The type of Currencies to return |
| 40 | +$eFilterActive = 'Active'; // string | Specify which results we want to display. |
| 41 | +$sQuery = 'sQuery_example'; // string | Allow to filter the returned results |
| 42 | +$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage |
| 43 | + |
| 44 | +try { |
| 45 | + $result = $apiInstance->currencyGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage); |
| 46 | + print_r($result); |
| 47 | +} catch (Exception $e) { |
| 48 | + echo 'Exception when calling ObjectCurrencyApi->currencyGetAutocompleteV2: ', $e->getMessage(), PHP_EOL; |
| 49 | +} |
| 50 | +``` |
| 51 | + |
| 52 | +### Parameters |
| 53 | + |
| 54 | +| Name | Type | Description | Notes | |
| 55 | +| ------------- | ------------- | ------------- | ------------- | |
| 56 | +| **sSelector** | **string**| The type of Currencies to return | | |
| 57 | +| **eFilterActive** | **string**| Specify which results we want to display. | [optional] [default to 'Active'] | |
| 58 | +| **sQuery** | **string**| Allow to filter the returned results | [optional] | |
| 59 | +| **acceptLanguage** | [**\eZmaxAPI\Model\HeaderAcceptLanguage**](../Model/.md)| | [optional] | |
| 60 | + |
| 61 | +### Return type |
| 62 | + |
| 63 | +[**\eZmaxAPI\Model\CurrencyGetAutocompleteV2Response**](../Model/CurrencyGetAutocompleteV2Response.md) |
| 64 | + |
| 65 | +### Authorization |
| 66 | + |
| 67 | +[Authorization](../../README.md#Authorization) |
| 68 | + |
| 69 | +### HTTP request headers |
| 70 | + |
| 71 | +- **Content-Type**: Not defined |
| 72 | +- **Accept**: `application/json` |
| 73 | + |
| 74 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 75 | +[[Back to Model list]](../../README.md#models) |
| 76 | +[[Back to README]](../../README.md) |
0 commit comments