Skip to content

ObjectRejectedoffertopurchaseApi.md

Latest commit

 

History

History
397 lines (266 loc) · 14.4 KB

ObjectRejectedoffertopurchaseApi.md

File metadata and controls

397 lines (266 loc) · 14.4 KB

eZmaxAPI\ObjectRejectedoffertopurchaseApi

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
rejectedoffertopurchaseGetCommunicationCountV1() GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationCount Retrieve Communication count
rejectedoffertopurchaseGetCommunicationListV1() GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList Retrieve Communication list
rejectedoffertopurchaseGetCommunicationrecipientsV1() GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationrecipients Retrieve Rejectedoffertopurchase's Communicationrecipient
rejectedoffertopurchaseGetCommunicationsendersV1() GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationsenders Retrieve Rejectedoffertopurchase's Communicationsender
rejectedoffertopurchaseGetListV1() GET /1/object/rejectedoffertopurchase/getList Retrieve Rejectedoffertopurchase list
rejectedoffertopurchaseImportIntoEDMV1() POST /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/importIntoEDM Import attachments into the Rejectedoffertopurchase

rejectedoffertopurchaseGetCommunicationCountV1()

rejectedoffertopurchaseGetCommunicationCountV1($pkiRejectedoffertopurchaseID): \eZmaxAPI\Model\RejectedoffertopurchaseGetCommunicationCountV1Response

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

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

Parameters

Name Type Description Notes
pkiRejectedoffertopurchaseID int

Return type

\eZmaxAPI\Model\RejectedoffertopurchaseGetCommunicationCountV1Response

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]

rejectedoffertopurchaseGetCommunicationListV1()

rejectedoffertopurchaseGetCommunicationListV1($pkiRejectedoffertopurchaseID): \eZmaxAPI\Model\RejectedoffertopurchaseGetCommunicationListV1Response

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

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

Parameters

Name Type Description Notes
pkiRejectedoffertopurchaseID int

Return type

\eZmaxAPI\Model\RejectedoffertopurchaseGetCommunicationListV1Response

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]

rejectedoffertopurchaseGetCommunicationrecipientsV1()

rejectedoffertopurchaseGetCommunicationrecipientsV1($pkiRejectedoffertopurchaseID): \eZmaxAPI\Model\RejectedoffertopurchaseGetCommunicationrecipientsV1Response

Retrieve Rejectedoffertopurchase'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\ObjectRejectedoffertopurchaseApi(
    // 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
);
$pkiRejectedoffertopurchaseID = 56; // int

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

Parameters

Name Type Description Notes
pkiRejectedoffertopurchaseID int

Return type

\eZmaxAPI\Model\RejectedoffertopurchaseGetCommunicationrecipientsV1Response

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]

rejectedoffertopurchaseGetCommunicationsendersV1()

rejectedoffertopurchaseGetCommunicationsendersV1($pkiRejectedoffertopurchaseID): \eZmaxAPI\Model\RejectedoffertopurchaseGetCommunicationsendersV1Response

Retrieve Rejectedoffertopurchase'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\ObjectRejectedoffertopurchaseApi(
    // 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
);
$pkiRejectedoffertopurchaseID = 56; // int

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

Parameters

Name Type Description Notes
pkiRejectedoffertopurchaseID int

Return type

\eZmaxAPI\Model\RejectedoffertopurchaseGetCommunicationsendersV1Response

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]

rejectedoffertopurchaseGetListV1()

rejectedoffertopurchaseGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\RejectedoffertopurchaseGetListV1Response

Retrieve Rejectedoffertopurchase 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\ObjectRejectedoffertopurchaseApi(
    // 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->rejectedoffertopurchaseGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectRejectedoffertopurchaseApi->rejectedoffertopurchaseGetListV1: ', $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\RejectedoffertopurchaseGetListV1Response

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]

rejectedoffertopurchaseImportIntoEDMV1()

rejectedoffertopurchaseImportIntoEDMV1($pkiRejectedoffertopurchaseID, $rejectedoffertopurchaseImportIntoEDMV1Request): \eZmaxAPI\Model\RejectedoffertopurchaseImportIntoEDMV1Response

Import attachments into the Rejectedoffertopurchase

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\ObjectRejectedoffertopurchaseApi(
    // 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
);
$pkiRejectedoffertopurchaseID = 56; // int
$rejectedoffertopurchaseImportIntoEDMV1Request = new \eZmaxAPI\Model\RejectedoffertopurchaseImportIntoEDMV1Request(); // \eZmaxAPI\Model\RejectedoffertopurchaseImportIntoEDMV1Request

try {
    $result = $apiInstance->rejectedoffertopurchaseImportIntoEDMV1($pkiRejectedoffertopurchaseID, $rejectedoffertopurchaseImportIntoEDMV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectRejectedoffertopurchaseApi->rejectedoffertopurchaseImportIntoEDMV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiRejectedoffertopurchaseID int
rejectedoffertopurchaseImportIntoEDMV1Request \eZmaxAPI\Model\RejectedoffertopurchaseImportIntoEDMV1Request

Return type

\eZmaxAPI\Model\RejectedoffertopurchaseImportIntoEDMV1Response

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]