Skip to content

ObjectEzsignfolderApi.md

Latest commit

 

History

History
2238 lines (1519 loc) · 77 KB

ObjectEzsignfolderApi.md

File metadata and controls

2238 lines (1519 loc) · 77 KB

eZmaxAPI\ObjectEzsignfolderApi

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
ezsignfolderArchiveV1() POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive Archive the Ezsignfolder
ezsignfolderBatchDownloadV1() POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload Download multiples files from an Ezsignfolder
ezsignfolderCreateObjectV1() POST /1/object/ezsignfolder Create a new Ezsignfolder
ezsignfolderCreateObjectV2() POST /2/object/ezsignfolder Create a new Ezsignfolder
ezsignfolderCreateObjectV3() POST /3/object/ezsignfolder Create a new Ezsignfolder
ezsignfolderDeleteObjectV1() DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} Delete an existing Ezsignfolder
ezsignfolderDisposeEzsignfoldersV1() POST /1/object/ezsignfolder/disposeEzsignfolders Dispose Ezsignfolders
ezsignfolderDisposeV1() POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose Dispose the Ezsignfolder
ezsignfolderEditObjectV3() PUT /3/object/ezsignfolder/{pkiEzsignfolderID} Edit an existing Ezsignfolder
ezsignfolderEndPrematurelyV1() POST /1/object/ezsignfolder/{pkiEzsignfolderID}/endPrematurely End prematurely
ezsignfolderGetActionableElementsV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements Retrieve actionable elements for the Ezsignfolder
ezsignfolderGetActionableElementsV2() GET /2/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements Retrieve actionable elements for the Ezsignfolder
ezsignfolderGetActionableElementsV3() GET /3/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements Retrieve actionable elements for the Ezsignfolder
ezsignfolderGetAttachmentCountV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount Retrieve Attachment count
ezsignfolderGetAttachmentsV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments Retrieve Ezsignfolder's Attachments
ezsignfolderGetCommunicationCountV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount Retrieve Communication count
ezsignfolderGetCommunicationListV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList Retrieve Communication list
ezsignfolderGetCommunicationrecipientsV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients Retrieve Ezsignfolder's Communicationrecipient
ezsignfolderGetCommunicationsendersV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders Retrieve Ezsignfolder's Communicationsender
ezsignfolderGetEzsigndocumentsV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments Retrieve an existing Ezsignfolder's Ezsigndocuments
ezsignfolderGetEzsigndocumentsV2() GET /2/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments Retrieve an existing Ezsignfolder's Ezsigndocuments
ezsignfolderGetEzsignfoldersignerassociationsV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
ezsignfolderGetEzsignsignaturesAutomaticV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
ezsignfolderGetFormsDataV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData Retrieve an existing Ezsignfolder's forms data
ezsignfolderGetListV1() GET /1/object/ezsignfolder/getList Retrieve Ezsignfolder list
ezsignfolderGetObjectV1() GET /1/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
ezsignfolderGetObjectV2() GET /2/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
ezsignfolderGetObjectV3() GET /3/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
ezsignfolderImportEzsignfoldersignerassociationsV1() POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
ezsignfolderImportEzsigntemplatepackageV1() POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage Import an Ezsigntemplatepackage in the Ezsignfolder
ezsignfolderImportEzsigntemplatepackageV2() POST /2/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage Import an Ezsigntemplatepackage in the Ezsignfolder
ezsignfolderReorderV2() POST /2/object/ezsignfolder/{pkiEzsignfolderID}/reorder Reorder Ezsigndocuments in the Ezsignfolder
ezsignfolderSendV1() POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
ezsignfolderSendV3() POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
ezsignfolderUnsendV1() POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend Unsend the Ezsignfolder

ezsignfolderArchiveV1()

ezsignfolderArchiveV1($pkiEzsignfolderID, $body): \eZmaxAPI\Model\EzsignfolderArchiveV1Response

Archive the Ezsignfolder

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$body = array('key' => new \stdClass); // object

try {
    $result = $apiInstance->ezsignfolderArchiveV1($pkiEzsignfolderID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderArchiveV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
body object

Return type

\eZmaxAPI\Model\EzsignfolderArchiveV1Response

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]

ezsignfolderBatchDownloadV1()

ezsignfolderBatchDownloadV1($pkiEzsignfolderID, $ezsignfolderBatchDownloadV1Request): \SplFileObject

Download multiples files from an Ezsignfolder

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$ezsignfolderBatchDownloadV1Request = new \eZmaxAPI\Model\EzsignfolderBatchDownloadV1Request(); // \eZmaxAPI\Model\EzsignfolderBatchDownloadV1Request

try {
    $result = $apiInstance->ezsignfolderBatchDownloadV1($pkiEzsignfolderID, $ezsignfolderBatchDownloadV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderBatchDownloadV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
ezsignfolderBatchDownloadV1Request \eZmaxAPI\Model\EzsignfolderBatchDownloadV1Request

Return type

\SplFileObject

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/zip, application/pdf, application/json

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

ezsignfolderCreateObjectV1()

ezsignfolderCreateObjectV1($ezsignfolderCreateObjectV1Request): \eZmaxAPI\Model\EzsignfolderCreateObjectV1Response

Create a new Ezsignfolder

The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects.

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\ObjectEzsignfolderApi(
    // 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
);
$ezsignfolderCreateObjectV1Request = array(new \eZmaxAPI\Model\EzsignfolderCreateObjectV1Request()); // \eZmaxAPI\Model\EzsignfolderCreateObjectV1Request[]

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

Parameters

Name Type Description Notes
ezsignfolderCreateObjectV1Request \eZmaxAPI\Model\EzsignfolderCreateObjectV1Request[]

Return type

\eZmaxAPI\Model\EzsignfolderCreateObjectV1Response

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]

ezsignfolderCreateObjectV2()

ezsignfolderCreateObjectV2($ezsignfolderCreateObjectV2Request): \eZmaxAPI\Model\EzsignfolderCreateObjectV2Response

Create a new Ezsignfolder

The endpoint allows to create one or many elements at once.

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\ObjectEzsignfolderApi(
    // 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
);
$ezsignfolderCreateObjectV2Request = new \eZmaxAPI\Model\EzsignfolderCreateObjectV2Request(); // \eZmaxAPI\Model\EzsignfolderCreateObjectV2Request

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

Parameters

Name Type Description Notes
ezsignfolderCreateObjectV2Request \eZmaxAPI\Model\EzsignfolderCreateObjectV2Request

Return type

\eZmaxAPI\Model\EzsignfolderCreateObjectV2Response

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]

ezsignfolderCreateObjectV3()

ezsignfolderCreateObjectV3($ezsignfolderCreateObjectV3Request): \eZmaxAPI\Model\EzsignfolderCreateObjectV3Response

Create a new Ezsignfolder

The endpoint allows to create one or many elements at once.

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\ObjectEzsignfolderApi(
    // 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
);
$ezsignfolderCreateObjectV3Request = new \eZmaxAPI\Model\EzsignfolderCreateObjectV3Request(); // \eZmaxAPI\Model\EzsignfolderCreateObjectV3Request

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

Parameters

Name Type Description Notes
ezsignfolderCreateObjectV3Request \eZmaxAPI\Model\EzsignfolderCreateObjectV3Request

Return type

\eZmaxAPI\Model\EzsignfolderCreateObjectV3Response

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]

ezsignfolderDeleteObjectV1()

ezsignfolderDeleteObjectV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderDeleteObjectV1Response

Delete an existing Ezsignfolder

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderDeleteObjectV1Response

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]

ezsignfolderDisposeEzsignfoldersV1()

ezsignfolderDisposeEzsignfoldersV1($ezsignfolderDisposeEzsignfoldersV1Request): \eZmaxAPI\Model\EzsignfolderDisposeEzsignfoldersV1Response

Dispose Ezsignfolders

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\ObjectEzsignfolderApi(
    // 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
);
$ezsignfolderDisposeEzsignfoldersV1Request = new \eZmaxAPI\Model\EzsignfolderDisposeEzsignfoldersV1Request(); // \eZmaxAPI\Model\EzsignfolderDisposeEzsignfoldersV1Request

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

Parameters

Name Type Description Notes
ezsignfolderDisposeEzsignfoldersV1Request \eZmaxAPI\Model\EzsignfolderDisposeEzsignfoldersV1Request

Return type

\eZmaxAPI\Model\EzsignfolderDisposeEzsignfoldersV1Response

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]

ezsignfolderDisposeV1()

ezsignfolderDisposeV1($pkiEzsignfolderID, $body): \eZmaxAPI\Model\EzsignfolderDisposeV1Response

Dispose the Ezsignfolder

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$body = array('key' => new \stdClass); // object

try {
    $result = $apiInstance->ezsignfolderDisposeV1($pkiEzsignfolderID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderDisposeV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
body object

Return type

\eZmaxAPI\Model\EzsignfolderDisposeV1Response

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]

ezsignfolderEditObjectV3()

ezsignfolderEditObjectV3($pkiEzsignfolderID, $ezsignfolderEditObjectV3Request): \eZmaxAPI\Model\EzsignfolderEditObjectV3Response

Edit an existing Ezsignfolder

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$ezsignfolderEditObjectV3Request = new \eZmaxAPI\Model\EzsignfolderEditObjectV3Request(); // \eZmaxAPI\Model\EzsignfolderEditObjectV3Request

try {
    $result = $apiInstance->ezsignfolderEditObjectV3($pkiEzsignfolderID, $ezsignfolderEditObjectV3Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderEditObjectV3: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
ezsignfolderEditObjectV3Request \eZmaxAPI\Model\EzsignfolderEditObjectV3Request

Return type

\eZmaxAPI\Model\EzsignfolderEditObjectV3Response

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]

ezsignfolderEndPrematurelyV1()

ezsignfolderEndPrematurelyV1($pkiEzsignfolderID, $body): \eZmaxAPI\Model\EzsignfolderEndPrematurelyV1Response

End prematurely

End prematurely all Ezsigndocument of Ezsignfolder when some signatures are still required

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$body = array('key' => new \stdClass); // object

try {
    $result = $apiInstance->ezsignfolderEndPrematurelyV1($pkiEzsignfolderID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderEndPrematurelyV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
body object

Return type

\eZmaxAPI\Model\EzsignfolderEndPrematurelyV1Response

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]

ezsignfolderGetActionableElementsV1()

ezsignfolderGetActionableElementsV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetActionableElementsV1Response

Retrieve actionable elements for the Ezsignfolder

Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process. Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetActionableElementsV1Response

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]

ezsignfolderGetActionableElementsV2()

ezsignfolderGetActionableElementsV2($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetActionableElementsV2Response

Retrieve actionable elements for the Ezsignfolder

Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled 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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetActionableElementsV2Response

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]

ezsignfolderGetActionableElementsV3()

ezsignfolderGetActionableElementsV3($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetActionableElementsV3Response

Retrieve actionable elements for the Ezsignfolder

Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled 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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetActionableElementsV3Response

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]

ezsignfolderGetAttachmentCountV1()

ezsignfolderGetAttachmentCountV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetAttachmentCountV1Response

Retrieve Attachment 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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetAttachmentCountV1Response

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]

ezsignfolderGetAttachmentsV1()

ezsignfolderGetAttachmentsV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetAttachmentsV1Response

Retrieve Ezsignfolder's Attachments

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetAttachmentsV1Response

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]

ezsignfolderGetCommunicationCountV1()

ezsignfolderGetCommunicationCountV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetCommunicationCountV1Response

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetCommunicationCountV1Response

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]

ezsignfolderGetCommunicationListV1()

ezsignfolderGetCommunicationListV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetCommunicationListV1Response

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetCommunicationListV1Response

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]

ezsignfolderGetCommunicationrecipientsV1()

ezsignfolderGetCommunicationrecipientsV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetCommunicationrecipientsV1Response

Retrieve Ezsignfolder'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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetCommunicationrecipientsV1Response

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]

ezsignfolderGetCommunicationsendersV1()

ezsignfolderGetCommunicationsendersV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetCommunicationsendersV1Response

Retrieve Ezsignfolder'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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetCommunicationsendersV1Response

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]

ezsignfolderGetEzsigndocumentsV1()

ezsignfolderGetEzsigndocumentsV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetEzsigndocumentsV1Response

Retrieve an existing Ezsignfolder's Ezsigndocuments

Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetEzsigndocumentsV1Response

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]

ezsignfolderGetEzsigndocumentsV2()

ezsignfolderGetEzsigndocumentsV2($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetEzsigndocumentsV2Response

Retrieve an existing Ezsignfolder's Ezsigndocuments

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetEzsigndocumentsV2Response

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]

ezsignfolderGetEzsignfoldersignerassociationsV1()

ezsignfolderGetEzsignfoldersignerassociationsV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetEzsignfoldersignerassociationsV1Response

Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetEzsignfoldersignerassociationsV1Response

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]

ezsignfolderGetEzsignsignaturesAutomaticV1()

ezsignfolderGetEzsignsignaturesAutomaticV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetEzsignsignaturesAutomaticV1Response

Retrieve an existing Ezsignfolder'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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetEzsignsignaturesAutomaticV1Response

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]

ezsignfolderGetFormsDataV1()

ezsignfolderGetFormsDataV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetFormsDataV1Response

Retrieve an existing Ezsignfolder'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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetFormsDataV1Response

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]

ezsignfolderGetListV1()

ezsignfolderGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\EzsignfolderGetListV1Response

Retrieve Ezsignfolder list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent
Sent
PartiallySigned
Expired
Completed
Archived
Disposed| | eEzsignfoldertypePrivacylevel | User
Usergroup | Advanced filters that can be used in query parameter sFilter: | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sUserFirstname | | sUserLastname | | sEzsigndocumentName |

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

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]

ezsignfolderGetObjectV1()

ezsignfolderGetObjectV1($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetObjectV1Response

Retrieve an existing Ezsignfolder

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetObjectV1Response

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]

ezsignfolderGetObjectV2()

ezsignfolderGetObjectV2($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetObjectV2Response

Retrieve an existing Ezsignfolder

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetObjectV2Response

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]

ezsignfolderGetObjectV3()

ezsignfolderGetObjectV3($pkiEzsignfolderID): \eZmaxAPI\Model\EzsignfolderGetObjectV3Response

Retrieve an existing Ezsignfolder

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

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

Parameters

Name Type Description Notes
pkiEzsignfolderID int

Return type

\eZmaxAPI\Model\EzsignfolderGetObjectV3Response

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]

ezsignfolderImportEzsignfoldersignerassociationsV1()

ezsignfolderImportEzsignfoldersignerassociationsV1($pkiEzsignfolderID, $ezsignfolderImportEzsignfoldersignerassociationsV1Request): \eZmaxAPI\Model\EzsignfolderImportEzsignfoldersignerassociationsV1Response

Import an existing Ezsignfoldersignerassociation into this Ezsignfolder

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$ezsignfolderImportEzsignfoldersignerassociationsV1Request = new \eZmaxAPI\Model\EzsignfolderImportEzsignfoldersignerassociationsV1Request(); // \eZmaxAPI\Model\EzsignfolderImportEzsignfoldersignerassociationsV1Request

try {
    $result = $apiInstance->ezsignfolderImportEzsignfoldersignerassociationsV1($pkiEzsignfolderID, $ezsignfolderImportEzsignfoldersignerassociationsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderImportEzsignfoldersignerassociationsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
ezsignfolderImportEzsignfoldersignerassociationsV1Request \eZmaxAPI\Model\EzsignfolderImportEzsignfoldersignerassociationsV1Request

Return type

\eZmaxAPI\Model\EzsignfolderImportEzsignfoldersignerassociationsV1Response

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]

ezsignfolderImportEzsigntemplatepackageV1()

ezsignfolderImportEzsigntemplatepackageV1($pkiEzsignfolderID, $ezsignfolderImportEzsigntemplatepackageV1Request): \eZmaxAPI\Model\EzsignfolderImportEzsigntemplatepackageV1Response

Import an Ezsigntemplatepackage in the Ezsignfolder

This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step. Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$ezsignfolderImportEzsigntemplatepackageV1Request = new \eZmaxAPI\Model\EzsignfolderImportEzsigntemplatepackageV1Request(); // \eZmaxAPI\Model\EzsignfolderImportEzsigntemplatepackageV1Request

try {
    $result = $apiInstance->ezsignfolderImportEzsigntemplatepackageV1($pkiEzsignfolderID, $ezsignfolderImportEzsigntemplatepackageV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderImportEzsigntemplatepackageV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
ezsignfolderImportEzsigntemplatepackageV1Request \eZmaxAPI\Model\EzsignfolderImportEzsigntemplatepackageV1Request

Return type

\eZmaxAPI\Model\EzsignfolderImportEzsigntemplatepackageV1Response

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]

ezsignfolderImportEzsigntemplatepackageV2()

ezsignfolderImportEzsigntemplatepackageV2($pkiEzsignfolderID, $ezsignfolderImportEzsigntemplatepackageV2Request): \eZmaxAPI\Model\EzsignfolderImportEzsigntemplatepackageV2Response

Import an Ezsigntemplatepackage in the Ezsignfolder

This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step.

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$ezsignfolderImportEzsigntemplatepackageV2Request = new \eZmaxAPI\Model\EzsignfolderImportEzsigntemplatepackageV2Request(); // \eZmaxAPI\Model\EzsignfolderImportEzsigntemplatepackageV2Request

try {
    $result = $apiInstance->ezsignfolderImportEzsigntemplatepackageV2($pkiEzsignfolderID, $ezsignfolderImportEzsigntemplatepackageV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderImportEzsigntemplatepackageV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
ezsignfolderImportEzsigntemplatepackageV2Request \eZmaxAPI\Model\EzsignfolderImportEzsigntemplatepackageV2Request

Return type

\eZmaxAPI\Model\EzsignfolderImportEzsigntemplatepackageV2Response

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]

ezsignfolderReorderV2()

ezsignfolderReorderV2($pkiEzsignfolderID, $ezsignfolderReorderV2Request): \eZmaxAPI\Model\EzsignfolderReorderV2Response

Reorder Ezsigndocuments in the Ezsignfolder

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$ezsignfolderReorderV2Request = new \eZmaxAPI\Model\EzsignfolderReorderV2Request(); // \eZmaxAPI\Model\EzsignfolderReorderV2Request

try {
    $result = $apiInstance->ezsignfolderReorderV2($pkiEzsignfolderID, $ezsignfolderReorderV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderReorderV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
ezsignfolderReorderV2Request \eZmaxAPI\Model\EzsignfolderReorderV2Request

Return type

\eZmaxAPI\Model\EzsignfolderReorderV2Response

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]

ezsignfolderSendV1()

ezsignfolderSendV1($pkiEzsignfolderID, $ezsignfolderSendV1Request): \eZmaxAPI\Model\EzsignfolderSendV1Response

Send the Ezsignfolder to the signatories for signature

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$ezsignfolderSendV1Request = new \eZmaxAPI\Model\EzsignfolderSendV1Request(); // \eZmaxAPI\Model\EzsignfolderSendV1Request

try {
    $result = $apiInstance->ezsignfolderSendV1($pkiEzsignfolderID, $ezsignfolderSendV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderSendV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
ezsignfolderSendV1Request \eZmaxAPI\Model\EzsignfolderSendV1Request

Return type

\eZmaxAPI\Model\EzsignfolderSendV1Response

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]

ezsignfolderSendV3()

ezsignfolderSendV3($pkiEzsignfolderID, $ezsignfolderSendV3Request): \eZmaxAPI\Model\EzsignfolderSendV3Response

Send the Ezsignfolder to the signatories for signature

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$ezsignfolderSendV3Request = new \eZmaxAPI\Model\EzsignfolderSendV3Request(); // \eZmaxAPI\Model\EzsignfolderSendV3Request

try {
    $result = $apiInstance->ezsignfolderSendV3($pkiEzsignfolderID, $ezsignfolderSendV3Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderSendV3: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
ezsignfolderSendV3Request \eZmaxAPI\Model\EzsignfolderSendV3Request

Return type

\eZmaxAPI\Model\EzsignfolderSendV3Response

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]

ezsignfolderUnsendV1()

ezsignfolderUnsendV1($pkiEzsignfolderID, $body): \eZmaxAPI\Model\EzsignfolderUnsendV1Response

Unsend the Ezsignfolder

Once an Ezsignfolder has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsignfolder and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on "Non-completed" Ezsigndocuments will be lost.

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\ObjectEzsignfolderApi(
    // 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
);
$pkiEzsignfolderID = 56; // int
$body = array('key' => new \stdClass); // object

try {
    $result = $apiInstance->ezsignfolderUnsendV1($pkiEzsignfolderID, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfolderApi->ezsignfolderUnsendV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignfolderID int
body object

Return type

\eZmaxAPI\Model\EzsignfolderUnsendV1Response

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]