Skip to content

OrganisationsApi.md

Latest commit

 

History

History
255 lines (176 loc) · 8.34 KB

OrganisationsApi.md

File metadata and controls

255 lines (176 loc) · 8.34 KB

SynergiTech\Cinolla\OrganisationsApi

All URIs are relative to https://api.prod.cinolla.com, except if the operation defines another base path.

Method HTTP request Description
createOrganisation() POST /v3/client/organisations Create a new Organisation
getOrganisation() GET /v3/client/organisations/{organisationHash} Get detail for a single Organisation
getOrganisations() GET /v3/client/organisations Returns a collection of Organisations
updateOrganisation() PATCH /v3/client/organisations/{organisationHash} Update an existing Organisation

createOrganisation()

createOrganisation($contactOrganisation2): \SynergiTech\Cinolla\Model\ContactOrganisation3

Create a new Organisation

Example

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


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


$apiInstance = new SynergiTech\Cinolla\Api\OrganisationsApi(
    // 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
);
$contactOrganisation2 = new \SynergiTech\Cinolla\Model\ContactOrganisation2(); // \SynergiTech\Cinolla\Model\ContactOrganisation2 | The Organisation to create

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

Parameters

Name Type Description Notes
contactOrganisation2 \SynergiTech\Cinolla\Model\ContactOrganisation2 The Organisation to create

Return type

\SynergiTech\Cinolla\Model\ContactOrganisation3

Authorization

ApiKeyAuth

HTTP request headers

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

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

getOrganisation()

getOrganisation($organisationHash): \SynergiTech\Cinolla\Model\ContactOrganisation4

Get detail for a single Organisation

Example

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


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


$apiInstance = new SynergiTech\Cinolla\Api\OrganisationsApi(
    // 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
);
$organisationHash = 'organisationHash_example'; // string

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

Parameters

Name Type Description Notes
organisationHash string

Return type

\SynergiTech\Cinolla\Model\ContactOrganisation4

Authorization

ApiKeyAuth

HTTP request headers

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

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

getOrganisations()

getOrganisations($offset, $limit): \SynergiTech\Cinolla\Model\ContactOrganisation[]

Returns a collection of Organisations

Example

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


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


$apiInstance = new SynergiTech\Cinolla\Api\OrganisationsApi(
    // 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
);
$offset = 0; // int | An offset to return a paginated list of results
$limit = 100; // int | The limit on the number of results

try {
    $result = $apiInstance->getOrganisations($offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationsApi->getOrganisations: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
offset int An offset to return a paginated list of results [optional] [default to 0]
limit int The limit on the number of results [optional] [default to 100]

Return type

\SynergiTech\Cinolla\Model\ContactOrganisation[]

Authorization

ApiKeyAuth

HTTP request headers

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

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

updateOrganisation()

updateOrganisation($organisationHash, $contactOrganisation5): \SynergiTech\Cinolla\Model\ContactOrganisation3

Update an existing Organisation

Example

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


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


$apiInstance = new SynergiTech\Cinolla\Api\OrganisationsApi(
    // 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
);
$organisationHash = 'organisationHash_example'; // string
$contactOrganisation5 = new \SynergiTech\Cinolla\Model\ContactOrganisation5(); // \SynergiTech\Cinolla\Model\ContactOrganisation5 | The Organisation fields to update

try {
    $result = $apiInstance->updateOrganisation($organisationHash, $contactOrganisation5);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganisationsApi->updateOrganisation: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
organisationHash string
contactOrganisation5 \SynergiTech\Cinolla\Model\ContactOrganisation5 The Organisation fields to update

Return type

\SynergiTech\Cinolla\Model\ContactOrganisation3

Authorization

ApiKeyAuth

HTTP request headers

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

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