Skip to content

Latest commit

 

History

History
323 lines (220 loc) · 9.81 KB

CharacteristicApi.md

File metadata and controls

323 lines (220 loc) · 9.81 KB
Raw

ProductApi\CharacteristicApi

All URIs are relative to http://localhost.

Method HTTP request Description
deleteCharacteristicItem() DELETE /api/characteristics/{id} Removes the Characteristic resource.
getCharacteristicCollection() GET /api/characteristics Retrieves the collection of Characteristic resources.
getCharacteristicItem() GET /api/characteristics/{id} Retrieves a Characteristic resource.
postCharacteristicCollection() POST /api/characteristics Creates a Characteristic resource.
putCharacteristicItem() PUT /api/characteristics/{id} Replaces the Characteristic resource.

deleteCharacteristicItem()

deleteCharacteristicItem($id)

Removes the Characteristic resource.

Removes the Characteristic resource.

Example

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


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


$apiInstance = new ProductApi\Api\CharacteristicApi(
    // 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 = 'id_example'; // string | Resource identifier

try {
    $apiInstance->deleteCharacteristicItem($id);
} catch (Exception $e) {
    echo 'Exception when calling CharacteristicApi->deleteCharacteristicItem: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string Resource identifier

Return type

void (empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getCharacteristicCollection()

getCharacteristicCollection($page): \ProductApi\Model\CharacteristicRead[]

Retrieves the collection of Characteristic resources.

Retrieves the collection of Characteristic resources.

Example

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


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


$apiInstance = new ProductApi\Api\CharacteristicApi(
    // 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
);
$page = 1; // int | The collection page number

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

Parameters

Name Type Description Notes
page int The collection page number [optional] [default to 1]

Return type

\ProductApi\Model\CharacteristicRead[]

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/html

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

getCharacteristicItem()

getCharacteristicItem($id): \ProductApi\Model\CharacteristicRead

Retrieves a Characteristic resource.

Retrieves a Characteristic resource.

Example

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


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


$apiInstance = new ProductApi\Api\CharacteristicApi(
    // 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 = 'id_example'; // string | Resource identifier

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

Parameters

Name Type Description Notes
id string Resource identifier

Return type

\ProductApi\Model\CharacteristicRead

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/html

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

postCharacteristicCollection()

postCharacteristicCollection($characteristic_write): \ProductApi\Model\CharacteristicRead

Creates a Characteristic resource.

Creates a Characteristic resource.

Example

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


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


$apiInstance = new ProductApi\Api\CharacteristicApi(
    // 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
);
$characteristic_write = new \ProductApi\Model\CharacteristicWrite(); // \ProductApi\Model\CharacteristicWrite | The new Characteristic resource

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

Parameters

Name Type Description Notes
characteristic_write \ProductApi\Model\CharacteristicWrite The new Characteristic resource

Return type

\ProductApi\Model\CharacteristicRead

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json, text/html
  • Accept: application/json, text/html

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

putCharacteristicItem()

putCharacteristicItem($id, $characteristic_write): \ProductApi\Model\CharacteristicRead

Replaces the Characteristic resource.

Replaces the Characteristic resource.

Example

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


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


$apiInstance = new ProductApi\Api\CharacteristicApi(
    // 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 = 'id_example'; // string | Resource identifier
$characteristic_write = new \ProductApi\Model\CharacteristicWrite(); // \ProductApi\Model\CharacteristicWrite | The updated Characteristic resource

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

Parameters

Name Type Description Notes
id string Resource identifier
characteristic_write \ProductApi\Model\CharacteristicWrite The updated Characteristic resource

Return type

\ProductApi\Model\CharacteristicRead

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json, text/html
  • Accept: application/json, text/html

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