Skip to content

Latest commit

 

History

History
323 lines (225 loc) · 11 KB

DirectorySiteApi.md

File metadata and controls

323 lines (225 loc) · 11 KB
Raw

EmonsiteApi\DirectorySiteApi

All URIs are relative to http://localhost.

Method HTTP request Description
deleteDirectorySiteItem() DELETE /directory_sites/{id} Removes the DirectorySite resource.
getDirectorySiteCollection() GET /directory_sites Retrieves the collection of DirectorySiteOutputDto resources.
getDirectorySiteItem() GET /directory_sites/{id} Retrieves a DirectorySiteOutputDto resource.
patchDirectorySiteItem() PATCH /directory_sites/{id} Updates the DirectorySite resource.
postDirectorySiteCollection() POST /directory_sites Creates a DirectorySite resource.

deleteDirectorySiteItem()

deleteDirectorySiteItem($id)

Removes the DirectorySite resource.

Example

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


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


$apiInstance = new EmonsiteApi\Api\DirectorySiteApi(
    // 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

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

Parameters

Name Type Description Notes
id string

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]

getDirectorySiteCollection()

getDirectorySiteCollection($category, $category2, $site, $site2, $page, $itemsPerPage): \EmonsiteApi\Models\GetDirectorySiteCollection200Response

Retrieves the collection of DirectorySiteOutputDto resources.

Example

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


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


$apiInstance = new EmonsiteApi\Api\DirectorySiteApi(
    // 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
);
$category = 'category_example'; // string
$category2 = array('category_example'); // string[]
$site = 'site_example'; // string
$site2 = array('site_example'); // string[]
$page = 1; // int | The collection page number
$itemsPerPage = 30; // int | The number of items per page

try {
    $result = $apiInstance->getDirectorySiteCollection($category, $category2, $site, $site2, $page, $itemsPerPage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DirectorySiteApi->getDirectorySiteCollection: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
category string [optional]
category2 string[] [optional]
site string [optional]
site2 string[] [optional]
page int The collection page number [optional] [default to 1]
itemsPerPage int The number of items per page [optional] [default to 30]

Return type

\EmonsiteApi\Models\GetDirectorySiteCollection200Response

Authorization

apiKey

HTTP request headers

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

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

getDirectorySiteItem()

getDirectorySiteItem($id): \EmonsiteApi\Models\DirectorySiteC4b6d694621fb452df0348553f6c643bJsonld

Retrieves a DirectorySiteOutputDto resource.

Example

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


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


$apiInstance = new EmonsiteApi\Api\DirectorySiteApi(
    // 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

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

Parameters

Name Type Description Notes
id string

Return type

\EmonsiteApi\Models\DirectorySiteC4b6d694621fb452df0348553f6c643bJsonld

Authorization

apiKey

HTTP request headers

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

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

patchDirectorySiteItem()

patchDirectorySiteItem($id, $directorySite966bbe081a8f082ba358af25f71a3895): \EmonsiteApi\Models\DirectorySiteC4b6d694621fb452df0348553f6c643bJsonld

Updates the DirectorySite resource.

Example

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


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


$apiInstance = new EmonsiteApi\Api\DirectorySiteApi(
    // 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
$directorySite966bbe081a8f082ba358af25f71a3895 = new \EmonsiteApi\Models\DirectorySite966bbe081a8f082ba358af25f71a3895(); // \EmonsiteApi\Models\DirectorySite966bbe081a8f082ba358af25f71a3895 | The updated DirectorySite resource

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

Parameters

Name Type Description Notes
id string
directorySite966bbe081a8f082ba358af25f71a3895 \EmonsiteApi\Models\DirectorySite966bbe081a8f082ba358af25f71a3895 The updated DirectorySite resource [optional]

Return type

\EmonsiteApi\Models\DirectorySiteC4b6d694621fb452df0348553f6c643bJsonld

Authorization

apiKey

HTTP request headers

  • Content-Type: application/merge-patch+json
  • Accept: application/ld+json, application/json, text/html

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

postDirectorySiteCollection()

postDirectorySiteCollection($directorySite9cb6adf6305292849b553106f66e2a8eJsonld): \EmonsiteApi\Models\DirectorySiteC4b6d694621fb452df0348553f6c643bJsonld

Creates a DirectorySite resource.

Example

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


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


$apiInstance = new EmonsiteApi\Api\DirectorySiteApi(
    // 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
);
$directorySite9cb6adf6305292849b553106f66e2a8eJsonld = new \EmonsiteApi\Models\DirectorySite9cb6adf6305292849b553106f66e2a8eJsonld(); // \EmonsiteApi\Models\DirectorySite9cb6adf6305292849b553106f66e2a8eJsonld | The new DirectorySite resource

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

Parameters

Name Type Description Notes
directorySite9cb6adf6305292849b553106f66e2a8eJsonld \EmonsiteApi\Models\DirectorySite9cb6adf6305292849b553106f66e2a8eJsonld The new DirectorySite resource [optional]

Return type

\EmonsiteApi\Models\DirectorySiteC4b6d694621fb452df0348553f6c643bJsonld

Authorization

apiKey

HTTP request headers

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

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