Skip to content

ObjectEzsignbulksendtransmissionApi.md

Latest commit

 

History

History
330 lines (223 loc) · 12.1 KB

ObjectEzsignbulksendtransmissionApi.md

File metadata and controls

330 lines (223 loc) · 12.1 KB

eZmaxAPI\ObjectEzsignbulksendtransmissionApi

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
ezsignbulksendtransmissionGetBatchFileV1() GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getBatchFile Retrieve file to download documents in batch
ezsignbulksendtransmissionGetCsvErrorsV1() GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getCsvErrors Retrieve an existing Ezsignbulksendtransmission's Csv containing errors
ezsignbulksendtransmissionGetEzsignsignaturesAutomaticV1() GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures
ezsignbulksendtransmissionGetFormsDataV1() GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData Retrieve an existing Ezsignbulksendtransmission's forms data
ezsignbulksendtransmissionGetObjectV2() GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} Retrieve an existing Ezsignbulksendtransmission

ezsignbulksendtransmissionGetBatchFileV1()

ezsignbulksendtransmissionGetBatchFileV1($pkiEzsignbulksendtransmissionID, $bIncludeSigned, $bIncludeAttachment, $bIncludeProofdocument, $bIncludeProof): \SplFileObject

Retrieve file to download documents in batch

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\ObjectEzsignbulksendtransmissionApi(
    // 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
);
$pkiEzsignbulksendtransmissionID = 56; // int
$bIncludeSigned = True; // bool | Include final document once all signatures were applied
$bIncludeAttachment = True; // bool | Include attached files in signatures
$bIncludeProofdocument = True; // bool | Include the evidence report
$bIncludeProof = True; // bool | include the complete evidence archive including all of the above and more

try {
    $result = $apiInstance->ezsignbulksendtransmissionGetBatchFileV1($pkiEzsignbulksendtransmissionID, $bIncludeSigned, $bIncludeAttachment, $bIncludeProofdocument, $bIncludeProof);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignbulksendtransmissionApi->ezsignbulksendtransmissionGetBatchFileV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignbulksendtransmissionID int
bIncludeSigned bool Include final document once all signatures were applied [optional]
bIncludeAttachment bool Include attached files in signatures [optional]
bIncludeProofdocument bool Include the evidence report [optional]
bIncludeProof bool include the complete evidence archive including all of the above and more [optional]

Return type

\SplFileObject

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/xml, application/json

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

ezsignbulksendtransmissionGetCsvErrorsV1()

ezsignbulksendtransmissionGetCsvErrorsV1($pkiEzsignbulksendtransmissionID): string

Retrieve an existing Ezsignbulksendtransmission's Csv containing errors

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

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

Parameters

Name Type Description Notes
pkiEzsignbulksendtransmissionID int

Return type

string

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/csv, application/json

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

ezsignbulksendtransmissionGetEzsignsignaturesAutomaticV1()

ezsignbulksendtransmissionGetEzsignsignaturesAutomaticV1($pkiEzsignbulksendtransmissionID): \eZmaxAPI\Model\EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response

Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures

Return the Ezsignsignatures that can be signed by the current user at the current step in the process

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

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

Parameters

Name Type Description Notes
pkiEzsignbulksendtransmissionID int

Return type

\eZmaxAPI\Model\EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response

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]

ezsignbulksendtransmissionGetFormsDataV1()

ezsignbulksendtransmissionGetFormsDataV1($pkiEzsignbulksendtransmissionID): \eZmaxAPI\Model\EzsignbulksendtransmissionGetFormsDataV1Response

Retrieve an existing Ezsignbulksendtransmission's forms data

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

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

Parameters

Name Type Description Notes
pkiEzsignbulksendtransmissionID int

Return type

\eZmaxAPI\Model\EzsignbulksendtransmissionGetFormsDataV1Response

Authorization

Authorization

HTTP request headers

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

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

ezsignbulksendtransmissionGetObjectV2()

ezsignbulksendtransmissionGetObjectV2($pkiEzsignbulksendtransmissionID): \eZmaxAPI\Model\EzsignbulksendtransmissionGetObjectV2Response

Retrieve an existing Ezsignbulksendtransmission

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

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

Parameters

Name Type Description Notes
pkiEzsignbulksendtransmissionID int

Return type

\eZmaxAPI\Model\EzsignbulksendtransmissionGetObjectV2Response

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]