|
| 1 | +# eZmaxAPI\ObjectEzmaxpartnerApi |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path. |
| 6 | + |
| 7 | +| Method | HTTP request | Description | |
| 8 | +| ------------- | ------------- | ------------- | |
| 9 | +| [**ezmaxpartnerGetCustomDeveloppersV1()**](ObjectEzmaxpartnerApi.md#ezmaxpartnerGetCustomDeveloppersV1) | **GET** /1/object/ezmaxpartner/getCustomDeveloppers | Retrieve Ezmaxpartner custom developpers list | |
| 10 | +| [**ezmaxpartnerGetObjectV2()**](ObjectEzmaxpartnerApi.md#ezmaxpartnerGetObjectV2) | **GET** /2/object/ezmaxpartner/{pkiEzmaxpartnerID} | Retrieve an existing Ezmaxpartner | |
| 11 | + |
| 12 | + |
| 13 | +## `ezmaxpartnerGetCustomDeveloppersV1()` |
| 14 | + |
| 15 | +```php |
| 16 | +ezmaxpartnerGetCustomDeveloppersV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\EzmaxpartnerGetCustomDeveloppersV1Response |
| 17 | +``` |
| 18 | + |
| 19 | +Retrieve Ezmaxpartner custom developpers list |
| 20 | + |
| 21 | +### Example |
| 22 | + |
| 23 | +```php |
| 24 | +<?php |
| 25 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 26 | + |
| 27 | + |
| 28 | +// Configure API key authorization: Authorization |
| 29 | +$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); |
| 30 | +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 31 | +// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); |
| 32 | + |
| 33 | + |
| 34 | +$apiInstance = new eZmaxAPI\Api\ObjectEzmaxpartnerApi( |
| 35 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 36 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 37 | + new GuzzleHttp\Client(), |
| 38 | + $config |
| 39 | +); |
| 40 | +$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted |
| 41 | +$iRowMax = 56; // int |
| 42 | +$iRowOffset = 0; // int |
| 43 | +$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage |
| 44 | +$sFilter = 'sFilter_example'; // string |
| 45 | + |
| 46 | +try { |
| 47 | + $result = $apiInstance->ezmaxpartnerGetCustomDeveloppersV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter); |
| 48 | + print_r($result); |
| 49 | +} catch (Exception $e) { |
| 50 | + echo 'Exception when calling ObjectEzmaxpartnerApi->ezmaxpartnerGetCustomDeveloppersV1: ', $e->getMessage(), PHP_EOL; |
| 51 | +} |
| 52 | +``` |
| 53 | + |
| 54 | +### Parameters |
| 55 | + |
| 56 | +| Name | Type | Description | Notes | |
| 57 | +| ------------- | ------------- | ------------- | ------------- | |
| 58 | +| **eOrderBy** | **string**| Specify how you want the results to be sorted | [optional] | |
| 59 | +| **iRowMax** | **int**| | [optional] | |
| 60 | +| **iRowOffset** | **int**| | [optional] [default to 0] | |
| 61 | +| **acceptLanguage** | [**\eZmaxAPI\Model\HeaderAcceptLanguage**](../Model/.md)| | [optional] | |
| 62 | +| **sFilter** | **string**| | [optional] | |
| 63 | + |
| 64 | +### Return type |
| 65 | + |
| 66 | +[**\eZmaxAPI\Model\EzmaxpartnerGetCustomDeveloppersV1Response**](../Model/EzmaxpartnerGetCustomDeveloppersV1Response.md) |
| 67 | + |
| 68 | +### Authorization |
| 69 | + |
| 70 | +[Authorization](../../README.md#Authorization) |
| 71 | + |
| 72 | +### HTTP request headers |
| 73 | + |
| 74 | +- **Content-Type**: Not defined |
| 75 | +- **Accept**: `application/json`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` |
| 76 | + |
| 77 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 78 | +[[Back to Model list]](../../README.md#models) |
| 79 | +[[Back to README]](../../README.md) |
| 80 | + |
| 81 | +## `ezmaxpartnerGetObjectV2()` |
| 82 | + |
| 83 | +```php |
| 84 | +ezmaxpartnerGetObjectV2($pkiEzmaxpartnerID): \eZmaxAPI\Model\EzmaxpartnerGetObjectV2Response |
| 85 | +``` |
| 86 | + |
| 87 | +Retrieve an existing Ezmaxpartner |
| 88 | + |
| 89 | + |
| 90 | + |
| 91 | +### Example |
| 92 | + |
| 93 | +```php |
| 94 | +<?php |
| 95 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 96 | + |
| 97 | + |
| 98 | +// Configure API key authorization: Authorization |
| 99 | +$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); |
| 100 | +// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed |
| 101 | +// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); |
| 102 | + |
| 103 | + |
| 104 | +$apiInstance = new eZmaxAPI\Api\ObjectEzmaxpartnerApi( |
| 105 | + // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. |
| 106 | + // This is optional, `GuzzleHttp\Client` will be used as default. |
| 107 | + new GuzzleHttp\Client(), |
| 108 | + $config |
| 109 | +); |
| 110 | +$pkiEzmaxpartnerID = 56; // int | The unique ID of the Ezmaxpartner |
| 111 | + |
| 112 | +try { |
| 113 | + $result = $apiInstance->ezmaxpartnerGetObjectV2($pkiEzmaxpartnerID); |
| 114 | + print_r($result); |
| 115 | +} catch (Exception $e) { |
| 116 | + echo 'Exception when calling ObjectEzmaxpartnerApi->ezmaxpartnerGetObjectV2: ', $e->getMessage(), PHP_EOL; |
| 117 | +} |
| 118 | +``` |
| 119 | + |
| 120 | +### Parameters |
| 121 | + |
| 122 | +| Name | Type | Description | Notes | |
| 123 | +| ------------- | ------------- | ------------- | ------------- | |
| 124 | +| **pkiEzmaxpartnerID** | **int**| The unique ID of the Ezmaxpartner | | |
| 125 | + |
| 126 | +### Return type |
| 127 | + |
| 128 | +[**\eZmaxAPI\Model\EzmaxpartnerGetObjectV2Response**](../Model/EzmaxpartnerGetObjectV2Response.md) |
| 129 | + |
| 130 | +### Authorization |
| 131 | + |
| 132 | +[Authorization](../../README.md#Authorization) |
| 133 | + |
| 134 | +### HTTP request headers |
| 135 | + |
| 136 | +- **Content-Type**: Not defined |
| 137 | +- **Accept**: `application/json` |
| 138 | + |
| 139 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 140 | +[[Back to Model list]](../../README.md#models) |
| 141 | +[[Back to README]](../../README.md) |
0 commit comments