Skip to content

Latest commit

 

History

History
259 lines (172 loc) · 8.21 KB

ObjectOtherincomeApi.md

File metadata and controls

259 lines (172 loc) · 8.21 KB

eZmaxAPI\ObjectOtherincomeApi

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
otherincomeGetCommunicationCountV1() GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationCount Retrieve Communication count
otherincomeGetCommunicationListV1() GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList Retrieve Communication list
otherincomeGetCommunicationrecipientsV1() GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationrecipients Retrieve Otherincome's Communicationrecipient
otherincomeGetCommunicationsendersV1() GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationsenders Retrieve Otherincome's Communicationsender

otherincomeGetCommunicationCountV1()

otherincomeGetCommunicationCountV1($pkiOtherincomeID): \eZmaxAPI\Model\OtherincomeGetCommunicationCountV1Response

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\ObjectOtherincomeApi(
    // 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
);
$pkiOtherincomeID = 56; // int

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

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

\eZmaxAPI\Model\OtherincomeGetCommunicationCountV1Response

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]

otherincomeGetCommunicationListV1()

otherincomeGetCommunicationListV1($pkiOtherincomeID): \eZmaxAPI\Model\OtherincomeGetCommunicationListV1Response

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\ObjectOtherincomeApi(
    // 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
);
$pkiOtherincomeID = 56; // int

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

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

\eZmaxAPI\Model\OtherincomeGetCommunicationListV1Response

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]

otherincomeGetCommunicationrecipientsV1()

otherincomeGetCommunicationrecipientsV1($pkiOtherincomeID): \eZmaxAPI\Model\OtherincomeGetCommunicationrecipientsV1Response

Retrieve Otherincome'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\ObjectOtherincomeApi(
    // 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
);
$pkiOtherincomeID = 56; // int

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

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

\eZmaxAPI\Model\OtherincomeGetCommunicationrecipientsV1Response

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]

otherincomeGetCommunicationsendersV1()

otherincomeGetCommunicationsendersV1($pkiOtherincomeID): \eZmaxAPI\Model\OtherincomeGetCommunicationsendersV1Response

Retrieve Otherincome'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\ObjectOtherincomeApi(
    // 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
);
$pkiOtherincomeID = 56; // int

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

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

\eZmaxAPI\Model\OtherincomeGetCommunicationsendersV1Response

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]