Skip to content

Latest commit

 

History

History
259 lines (172 loc) · 8.37 KB

ObjectTranqcontractApi.md

File metadata and controls

259 lines (172 loc) · 8.37 KB

eZmaxAPI\ObjectTranqcontractApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest, except if the operation defines another base path.

Method HTTP request Description
tranqcontractGetCommunicationCountV1() GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationCount Retrieve Communication count
tranqcontractGetCommunicationListV1() GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationList Retrieve Communication list
tranqcontractGetCommunicationrecipientsV1() GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationrecipients Retrieve Tranqcontract's Communicationrecipient
tranqcontractGetCommunicationsendersV1() GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationsenders Retrieve Tranqcontract's Communicationsender

tranqcontractGetCommunicationCountV1()

tranqcontractGetCommunicationCountV1($pkiTranqcontractID): \eZmaxAPI\Model\TranqcontractGetCommunicationCountV1Response

Retrieve Communication count

Example

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


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


$apiInstance = new eZmaxAPI\Api\ObjectTranqcontractApi(
    // 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
);
$pkiTranqcontractID = 56; // int

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

Parameters

Name Type Description Notes
pkiTranqcontractID int

Return type

\eZmaxAPI\Model\TranqcontractGetCommunicationCountV1Response

Authorization

Authorization

HTTP request headers

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

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

tranqcontractGetCommunicationListV1()

tranqcontractGetCommunicationListV1($pkiTranqcontractID): \eZmaxAPI\Model\TranqcontractGetCommunicationListV1Response

Retrieve Communication list

Example

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


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


$apiInstance = new eZmaxAPI\Api\ObjectTranqcontractApi(
    // 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
);
$pkiTranqcontractID = 56; // int

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

Parameters

Name Type Description Notes
pkiTranqcontractID int

Return type

\eZmaxAPI\Model\TranqcontractGetCommunicationListV1Response

Authorization

Authorization

HTTP request headers

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

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

tranqcontractGetCommunicationrecipientsV1()

tranqcontractGetCommunicationrecipientsV1($pkiTranqcontractID): \eZmaxAPI\Model\TranqcontractGetCommunicationrecipientsV1Response

Retrieve Tranqcontract's Communicationrecipient

Example

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


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


$apiInstance = new eZmaxAPI\Api\ObjectTranqcontractApi(
    // 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
);
$pkiTranqcontractID = 56; // int

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

Parameters

Name Type Description Notes
pkiTranqcontractID int

Return type

\eZmaxAPI\Model\TranqcontractGetCommunicationrecipientsV1Response

Authorization

Authorization

HTTP request headers

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

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

tranqcontractGetCommunicationsendersV1()

tranqcontractGetCommunicationsendersV1($pkiTranqcontractID): \eZmaxAPI\Model\TranqcontractGetCommunicationsendersV1Response

Retrieve Tranqcontract's Communicationsender

Example

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


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


$apiInstance = new eZmaxAPI\Api\ObjectTranqcontractApi(
    // 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
);
$pkiTranqcontractID = 56; // int

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

Parameters

Name Type Description Notes
pkiTranqcontractID int

Return type

\eZmaxAPI\Model\TranqcontractGetCommunicationsendersV1Response

Authorization

Authorization

HTTP request headers

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

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