Skip to content

ObjectInscriptiontempApi.md

Latest commit

 

History

History
397 lines (267 loc) · 13.6 KB

ObjectInscriptiontempApi.md

File metadata and controls

397 lines (267 loc) · 13.6 KB

eZmaxAPI\ObjectInscriptiontempApi

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
inscriptiontempGetCommunicationCountV1() GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationCount Retrieve Communication count
inscriptiontempGetCommunicationListV1() GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList Retrieve Communication list
inscriptiontempGetCommunicationrecipientsV1() GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationrecipients Retrieve Inscriptiontemp's Communicationrecipient
inscriptiontempGetCommunicationsendersV1() GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationsenders Retrieve Inscriptiontemp's Communicationsender
inscriptiontempGetListV1() GET /1/object/inscriptiontemp/getList Retrieve Inscriptiontemp list
inscriptiontempImportIntoEDMV1() POST /1/object/inscriptiontemp/{pkiInscriptiontempID}/importIntoEDM Import attachments into the Inscriptiontemp

inscriptiontempGetCommunicationCountV1()

inscriptiontempGetCommunicationCountV1($pkiInscriptiontempID): \eZmaxAPI\Model\InscriptiontempGetCommunicationCountV1Response

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

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

Parameters

Name Type Description Notes
pkiInscriptiontempID int

Return type

\eZmaxAPI\Model\InscriptiontempGetCommunicationCountV1Response

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]

inscriptiontempGetCommunicationListV1()

inscriptiontempGetCommunicationListV1($pkiInscriptiontempID): \eZmaxAPI\Model\InscriptiontempGetCommunicationListV1Response

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

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

Parameters

Name Type Description Notes
pkiInscriptiontempID int

Return type

\eZmaxAPI\Model\InscriptiontempGetCommunicationListV1Response

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]

inscriptiontempGetCommunicationrecipientsV1()

inscriptiontempGetCommunicationrecipientsV1($pkiInscriptiontempID): \eZmaxAPI\Model\InscriptiontempGetCommunicationrecipientsV1Response

Retrieve Inscriptiontemp'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\ObjectInscriptiontempApi(
    // 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
);
$pkiInscriptiontempID = 56; // int

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

Parameters

Name Type Description Notes
pkiInscriptiontempID int

Return type

\eZmaxAPI\Model\InscriptiontempGetCommunicationrecipientsV1Response

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]

inscriptiontempGetCommunicationsendersV1()

inscriptiontempGetCommunicationsendersV1($pkiInscriptiontempID): \eZmaxAPI\Model\InscriptiontempGetCommunicationsendersV1Response

Retrieve Inscriptiontemp'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\ObjectInscriptiontempApi(
    // 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
);
$pkiInscriptiontempID = 56; // int

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

Parameters

Name Type Description Notes
pkiInscriptiontempID int

Return type

\eZmaxAPI\Model\InscriptiontempGetCommunicationsendersV1Response

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]

inscriptiontempGetListV1()

inscriptiontempGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\InscriptiontempGetListV1Response

Retrieve Inscriptiontemp list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eInscriptiontempStatus | Imported
Processed
Modified |

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

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]

inscriptiontempImportIntoEDMV1()

inscriptiontempImportIntoEDMV1($pkiInscriptiontempID, $inscriptiontempImportIntoEDMV1Request): \eZmaxAPI\Model\InscriptiontempImportIntoEDMV1Response

Import attachments into the Inscriptiontemp

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\ObjectInscriptiontempApi(
    // 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
);
$pkiInscriptiontempID = 56; // int
$inscriptiontempImportIntoEDMV1Request = new \eZmaxAPI\Model\InscriptiontempImportIntoEDMV1Request(); // \eZmaxAPI\Model\InscriptiontempImportIntoEDMV1Request

try {
    $result = $apiInstance->inscriptiontempImportIntoEDMV1($pkiInscriptiontempID, $inscriptiontempImportIntoEDMV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectInscriptiontempApi->inscriptiontempImportIntoEDMV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiInscriptiontempID int
inscriptiontempImportIntoEDMV1Request \eZmaxAPI\Model\InscriptiontempImportIntoEDMV1Request

Return type

\eZmaxAPI\Model\InscriptiontempImportIntoEDMV1Response

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]