Skip to content

ObjectBuyercontractApi.md

Latest commit

 

History

History
397 lines (267 loc) · 13.5 KB

ObjectBuyercontractApi.md

File metadata and controls

397 lines (267 loc) · 13.5 KB

eZmaxAPI\ObjectBuyercontractApi

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
buyercontractGetCommunicationCountV1() GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationCount Retrieve Communication count
buyercontractGetCommunicationListV1() GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList Retrieve Communication list
buyercontractGetCommunicationrecipientsV1() GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationrecipients Retrieve Buyercontract's Communicationrecipient
buyercontractGetCommunicationsendersV1() GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationsenders Retrieve Buyercontract's Communicationsender
buyercontractGetListV1() GET /1/object/buyercontract/getList Retrieve Buyercontract list
buyercontractImportIntoEDMV1() POST /1/object/buyercontract/{pkiBuyercontractID}/importIntoEDM Import attachments into the Buyercontract

buyercontractGetCommunicationCountV1()

buyercontractGetCommunicationCountV1($pkiBuyercontractID): \eZmaxAPI\Model\BuyercontractGetCommunicationCountV1Response

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

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

Parameters

Name Type Description Notes
pkiBuyercontractID int

Return type

\eZmaxAPI\Model\BuyercontractGetCommunicationCountV1Response

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]

buyercontractGetCommunicationListV1()

buyercontractGetCommunicationListV1($pkiBuyercontractID): \eZmaxAPI\Model\BuyercontractGetCommunicationListV1Response

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

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

Parameters

Name Type Description Notes
pkiBuyercontractID int

Return type

\eZmaxAPI\Model\BuyercontractGetCommunicationListV1Response

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]

buyercontractGetCommunicationrecipientsV1()

buyercontractGetCommunicationrecipientsV1($pkiBuyercontractID): \eZmaxAPI\Model\BuyercontractGetCommunicationrecipientsV1Response

Retrieve Buyercontract'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\ObjectBuyercontractApi(
    // 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
);
$pkiBuyercontractID = 56; // int

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

Parameters

Name Type Description Notes
pkiBuyercontractID int

Return type

\eZmaxAPI\Model\BuyercontractGetCommunicationrecipientsV1Response

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]

buyercontractGetCommunicationsendersV1()

buyercontractGetCommunicationsendersV1($pkiBuyercontractID): \eZmaxAPI\Model\BuyercontractGetCommunicationsendersV1Response

Retrieve Buyercontract'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\ObjectBuyercontractApi(
    // 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
);
$pkiBuyercontractID = 56; // int

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

Parameters

Name Type Description Notes
pkiBuyercontractID int

Return type

\eZmaxAPI\Model\BuyercontractGetCommunicationsendersV1Response

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]

buyercontractGetListV1()

buyercontractGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\BuyercontractGetListV1Response

Retrieve Buyercontract list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eBuyercontractStep | Imported
Active
Modified
ContractEnded
ExpiredContract
Bought | | eBuyercontractType | Rent
Sale
RentOrSale |

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\ObjectBuyercontractApi(
    // 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
);
$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted
$iRowMax = 56; // int
$iRowOffset = 0; // int
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$sFilter = 'sFilter_example'; // string

try {
    $result = $apiInstance->buyercontractGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectBuyercontractApi->buyercontractGetListV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
eOrderBy string Specify how you want the results to be sorted [optional]
iRowMax int [optional]
iRowOffset int [optional] [default to 0]
acceptLanguage \eZmaxAPI\Model\HeaderAcceptLanguage [optional]
sFilter string [optional]

Return type

\eZmaxAPI\Model\BuyercontractGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

buyercontractImportIntoEDMV1()

buyercontractImportIntoEDMV1($pkiBuyercontractID, $buyercontractImportIntoEDMV1Request): \eZmaxAPI\Model\BuyercontractImportIntoEDMV1Response

Import attachments into the Buyercontract

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\ObjectBuyercontractApi(
    // 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
);
$pkiBuyercontractID = 56; // int
$buyercontractImportIntoEDMV1Request = new \eZmaxAPI\Model\BuyercontractImportIntoEDMV1Request(); // \eZmaxAPI\Model\BuyercontractImportIntoEDMV1Request

try {
    $result = $apiInstance->buyercontractImportIntoEDMV1($pkiBuyercontractID, $buyercontractImportIntoEDMV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectBuyercontractApi->buyercontractImportIntoEDMV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiBuyercontractID int
buyercontractImportIntoEDMV1Request \eZmaxAPI\Model\BuyercontractImportIntoEDMV1Request

Return type

\eZmaxAPI\Model\BuyercontractImportIntoEDMV1Response

Authorization

Authorization

HTTP request headers

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

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