Skip to content

Files

Latest commit

 

History

History
178 lines (121 loc) · 4.53 KB

EnquiryApi.md

File metadata and controls

178 lines (121 loc) · 4.53 KB

SynergiTech\Iplicit\EnquiryApi

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

Method HTTP request Description
runEnquiry() POST /api/Enquiry/run/{id} Run an enquiry that returns a list
runEnquiryToList() POST /api/Enquiry/run/{id}/list Run an enquiry that returns a list
runEnquiryToTable() POST /api/Enquiry/run/{id}/table Run an enquiry that returns a table

runEnquiry()

runEnquiry($id, $body): mixed[]

Run an enquiry that returns a list

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\EnquiryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$id = 'id_example'; // string | Id of the enquiry
$body = NULL; // mixed

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

Parameters

Name Type Description Notes
id string Id of the enquiry
body mixed [optional]

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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

runEnquiryToList()

runEnquiryToList($id, $body): mixed[]

Run an enquiry that returns a list

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\EnquiryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$id = 'id_example'; // string | Id of the enquiry
$body = NULL; // mixed

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

Parameters

Name Type Description Notes
id string Id of the enquiry
body mixed [optional]

Return type

mixed[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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

runEnquiryToTable()

runEnquiryToTable($id, $body): \SynergiTech\Iplicit\Model\Table

Run an enquiry that returns a table

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\EnquiryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$id = 'id_example'; // string | Id of the enquiry
$body = NULL; // mixed

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

Parameters

Name Type Description Notes
id string Id of the enquiry
body mixed [optional]

Return type

\SynergiTech\Iplicit\Model\Table

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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