Skip to content

Latest commit

 

History

History
281 lines (197 loc) · 9.7 KB

BusinessmodelsApi.md

File metadata and controls

281 lines (197 loc) · 9.7 KB
Raw

Ageras\Api\BusinessmodelsApi

All URIs are relative to https://api.ageras.com/v2

Method HTTP request Description
businessModelsCreate POST /business_models
businessModelsDelete DELETE /business_models/{business_model_id}
businessModelsGet GET /business_models/{business_model_id}
businessModelsIndex GET /business_models
businessModelsUpdate PUT /business_models/{business_model_id}

businessModelsCreate

\Ageras\Api\BusinessModelResource businessModelsCreate($business_model_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\BusinessmodelsApi();
$business_model_resource = new \Ageras\Api\BusinessModelResource(); // \Ageras\Api\BusinessModelResource | 

try {
    $result = $api_instance->businessModelsCreate($business_model_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessmodelsApi->businessModelsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
business_model_resource \Ageras\Api\BusinessModelResource

Return type

\Ageras\Api\BusinessModelResource

Authorization

jwt, login

HTTP request headers

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

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

businessModelsDelete

businessModelsDelete($business_model_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\BusinessmodelsApi();
$business_model_id = "business_model_id_example"; // string | 

try {
    $api_instance->businessModelsDelete($business_model_id );
} catch (Exception $e) {
    echo 'Exception when calling BusinessmodelsApi->businessModelsDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
business_model_id string

Return type

void (empty response body)

Authorization

jwt, login

HTTP request headers

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

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

businessModelsGet

\Ageras\Api\BusinessModelResource businessModelsGet($business_model_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\BusinessmodelsApi();
$business_model_id = "business_model_id_example"; // string | 

try {
    $result = $api_instance->businessModelsGet($business_model_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessmodelsApi->businessModelsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
business_model_id string

Return type

\Ageras\Api\BusinessModelResource

Authorization

jwt, login

HTTP request headers

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

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

businessModelsIndex

\Ageras\Api\BusinessModelResult businessModelsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\BusinessmodelsApi();
$criteria = [
        'business_model_id' => "business_model_id_example"; // string | 
        'identifier' => "identifier_example"; // string | 
        'geo_code' => "geo_code_example"; // string | 
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->businessModelsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessmodelsApi->businessModelsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
business_model_id string [optional]
identifier string [optional]
geo_code string [optional]
limit int The number of resources to be returned. [optional]
page int The page position in the result. [optional]
query string The search wildcard. [optional]

Return type

\Ageras\Api\BusinessModelResult

Authorization

jwt, login

HTTP request headers

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

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

businessModelsUpdate

\Ageras\Api\BusinessModelResource businessModelsUpdate($business_model_id , $business_model_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\BusinessmodelsApi();
$business_model_id = "business_model_id_example"; // string | 
$business_model_resource = new \Ageras\Api\BusinessModelResource(); // \Ageras\Api\BusinessModelResource | 

try {
    $result = $api_instance->businessModelsUpdate($business_model_id , $business_model_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BusinessmodelsApi->businessModelsUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
business_model_id string
business_model_resource \Ageras\Api\BusinessModelResource

Return type

\Ageras\Api\BusinessModelResource

Authorization

jwt, login

HTTP request headers

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

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