Skip to content

Latest commit

 

History

History
executable file
·
60 lines (43 loc) · 2.17 KB

CheckApi.md

File metadata and controls

executable file
·
60 lines (43 loc) · 2.17 KB

ASMP\Client\CheckApi

All URIs are relative to https://swagger.asmprotocol.org/v1

Method HTTP request Description
check POST /check Define a list of desired changes using abstract constraints. Server should process these constraints, check if they can be fulfilled and respond with the possible resolutions.

check

\ASMP\Client\Model\CheckResponse check($body)

Define a list of desired changes using abstract constraints. Server should process these constraints, check if they can be fulfilled and respond with the possible resolutions.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: asmp_auth
$config = ASMP\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ASMP\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$apiInstance = new ASMP\Client\Api\CheckApi(
    // 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
);
$body = new \ASMP\Client\Model\CheckRequest(); // \ASMP\Client\Model\CheckRequest | Check request

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

Parameters

Name Type Description Notes
body \ASMP\Client\Model\CheckRequest Check request

Return type

\ASMP\Client\Model\CheckResponse

Authorization

asmp_auth

HTTP request headers

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

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