Skip to content

EnquiriesApi.md

Latest commit

 

History

History
196 lines (136 loc) · 6.16 KB

EnquiriesApi.md

File metadata and controls

196 lines (136 loc) · 6.16 KB

SynergiTech\Cinolla\EnquiriesApi

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

Method HTTP request Description
createEnquiry() POST /v3/client/enquiries Create a new Enquiry
getEnquiries() GET /v3/client/enquiries Returns a collection of Enquiries
getEnquiry() GET /v3/client/enquiries/{id} Get detail for a single Enquiry

createEnquiry()

createEnquiry($enquiry2, $contactHash, $organisationHash): \SynergiTech\Cinolla\Model\Enquiry3

Create a new Enquiry

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\EnquiriesApi(
    // 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
);
$enquiry2 = new \SynergiTech\Cinolla\Model\Enquiry2(); // \SynergiTech\Cinolla\Model\Enquiry2 | The Enquiry to create
$contactHash = 'contactHash_example'; // string | Hash of the Contact to associate with this enquiry
$organisationHash = 'organisationHash_example'; // string | Hash of the Organisation to associate with this enquiry

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

Parameters

Name Type Description Notes
enquiry2 \SynergiTech\Cinolla\Model\Enquiry2 The Enquiry to create
contactHash string Hash of the Contact to associate with this enquiry [optional]
organisationHash string Hash of the Organisation to associate with this enquiry [optional]

Return type

\SynergiTech\Cinolla\Model\Enquiry3

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]

getEnquiries()

getEnquiries($offset, $limit): \SynergiTech\Cinolla\Model\Enquiry[]

Returns a collection of Enquiries

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\EnquiriesApi(
    // 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->getEnquiries($offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnquiriesApi->getEnquiries: ', $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\Enquiry[]

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]

getEnquiry()

getEnquiry($id): \SynergiTech\Cinolla\Model\Enquiry3

Get detail for a single Enquiry

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\EnquiriesApi(
    // 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->getEnquiry($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EnquiriesApi->getEnquiry: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id string

Return type

\SynergiTech\Cinolla\Model\Enquiry3

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]