Skip to content

ObjectEzsigntemplatedocumentApi.md

Latest commit

 

History

History
1034 lines (700 loc) · 40.8 KB

ObjectEzsigntemplatedocumentApi.md

File metadata and controls

1034 lines (700 loc) · 40.8 KB

eZmaxAPI\ObjectEzsigntemplatedocumentApi

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
ezsigntemplatedocumentCreateObjectV1() POST /1/object/ezsigntemplatedocument Create a new Ezsigntemplatedocument
ezsigntemplatedocumentDownloadV1() GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/download Retrieve an existing Ezsigntemplatedocument's original file
ezsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1() PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatedocumentpagerecognitions Edit multiple Ezsigntemplatedocumentpagerecognitions
ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1() PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups Edit multiple Ezsigntemplateformfieldgroups
ezsigntemplatedocumentEditEzsigntemplatesignaturesV1() PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures Edit multiple Ezsigntemplatesignatures
ezsigntemplatedocumentEditEzsigntemplatesignaturesV2() PUT /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures Edit multiple Ezsigntemplatesignatures
ezsigntemplatedocumentEditObjectV1() PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Edit an existing Ezsigntemplatedocument
ezsigntemplatedocumentExtractTextV1() POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/extractText Extract text from Ezsigntemplatedocument area
ezsigntemplatedocumentFlattenV1() POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten Flatten
ezsigntemplatedocumentGetEzsigntemplatedocumentpagerecognitionsV1() GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpagerecognitions Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpagerecognitions
ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1() GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages
ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1() GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplateformfieldgroups Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups
ezsigntemplatedocumentGetEzsigntemplatesignaturesV2() GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures
ezsigntemplatedocumentGetObjectV2() GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Retrieve an existing Ezsigntemplatedocument
ezsigntemplatedocumentGetWordsPositionsV1() POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigntemplatedocument
ezsigntemplatedocumentPatchObjectV1() PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Patch an existing Ezsigntemplatedocument

ezsigntemplatedocumentCreateObjectV1()

ezsigntemplatedocumentCreateObjectV1($ezsigntemplatedocumentCreateObjectV1Request): \eZmaxAPI\Model\EzsigntemplatedocumentCreateObjectV1Response

Create a new Ezsigntemplatedocument

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\ObjectEzsigntemplatedocumentApi(
    // 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
);
$ezsigntemplatedocumentCreateObjectV1Request = new \eZmaxAPI\Model\EzsigntemplatedocumentCreateObjectV1Request(); // \eZmaxAPI\Model\EzsigntemplatedocumentCreateObjectV1Request

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

Parameters

Name Type Description Notes
ezsigntemplatedocumentCreateObjectV1Request \eZmaxAPI\Model\EzsigntemplatedocumentCreateObjectV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentCreateObjectV1Response

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]

ezsigntemplatedocumentDownloadV1()

ezsigntemplatedocumentDownloadV1($pkiEzsigntemplatedocumentID)

Retrieve an existing Ezsigntemplatedocument's original file

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

try {
    $apiInstance->ezsigntemplatedocumentDownloadV1($pkiEzsigntemplatedocumentID);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocumentDownloadV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int

Return type

void (empty response body)

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]

ezsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1()

ezsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1Request): \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1Response

Edit multiple Ezsigntemplatedocumentpagerecognitions

Edit multiple Ezsigntemplatedocumentpagerecognitions

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\ObjectEzsigntemplatedocumentApi(
    // 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
);
$pkiEzsigntemplatedocumentID = 56; // int
$ezsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1Request = new \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1Request(); // \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1Request

try {
    $result = $apiInstance->ezsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int
ezsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1Request \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatedocumentpagerecognitionsV1Response

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]

ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1()

ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request): \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response

Edit multiple Ezsigntemplateformfieldgroups

Using this endpoint, you can edit multiple Ezsigntemplateformfieldgroups at the same time.

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\ObjectEzsigntemplatedocumentApi(
    // 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
);
$pkiEzsigntemplatedocumentID = 56; // int
$ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request = new \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request(); // \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request

try {
    $result = $apiInstance->ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int
ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response

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]

ezsigntemplatedocumentEditEzsigntemplatesignaturesV1()

ezsigntemplatedocumentEditEzsigntemplatesignaturesV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentEditEzsigntemplatesignaturesV1Request): \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response

Edit multiple Ezsigntemplatesignatures

Using this endpoint, you can edit multiple Ezsigntemplatesignatures at the same time. 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\ObjectEzsigntemplatedocumentApi(
    // 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
);
$pkiEzsigntemplatedocumentID = 56; // int
$ezsigntemplatedocumentEditEzsigntemplatesignaturesV1Request = new \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request(); // \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request

try {
    $result = $apiInstance->ezsigntemplatedocumentEditEzsigntemplatesignaturesV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentEditEzsigntemplatesignaturesV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocumentEditEzsigntemplatesignaturesV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int
ezsigntemplatedocumentEditEzsigntemplatesignaturesV1Request \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response

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]

ezsigntemplatedocumentEditEzsigntemplatesignaturesV2()

ezsigntemplatedocumentEditEzsigntemplatesignaturesV2($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentEditEzsigntemplatesignaturesV2Request): \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatesignaturesV2Response

Edit multiple Ezsigntemplatesignatures

Using this endpoint, you can edit multiple Ezsigntemplatesignatures at the same time.

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\ObjectEzsigntemplatedocumentApi(
    // 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
);
$pkiEzsigntemplatedocumentID = 56; // int
$ezsigntemplatedocumentEditEzsigntemplatesignaturesV2Request = new \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatesignaturesV2Request(); // \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatesignaturesV2Request

try {
    $result = $apiInstance->ezsigntemplatedocumentEditEzsigntemplatesignaturesV2($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentEditEzsigntemplatesignaturesV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocumentEditEzsigntemplatesignaturesV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int
ezsigntemplatedocumentEditEzsigntemplatesignaturesV2Request \eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatesignaturesV2Request

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentEditEzsigntemplatesignaturesV2Response

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]

ezsigntemplatedocumentEditObjectV1()

ezsigntemplatedocumentEditObjectV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentEditObjectV1Request): \eZmaxAPI\Model\EzsigntemplatedocumentEditObjectV1Response

Edit an existing Ezsigntemplatedocument

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\ObjectEzsigntemplatedocumentApi(
    // 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
);
$pkiEzsigntemplatedocumentID = 56; // int
$ezsigntemplatedocumentEditObjectV1Request = new \eZmaxAPI\Model\EzsigntemplatedocumentEditObjectV1Request(); // \eZmaxAPI\Model\EzsigntemplatedocumentEditObjectV1Request

try {
    $result = $apiInstance->ezsigntemplatedocumentEditObjectV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocumentEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int
ezsigntemplatedocumentEditObjectV1Request \eZmaxAPI\Model\EzsigntemplatedocumentEditObjectV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentEditObjectV1Response

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]

ezsigntemplatedocumentExtractTextV1()

ezsigntemplatedocumentExtractTextV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentExtractTextV1Request): \eZmaxAPI\Model\EzsigntemplatedocumentExtractTextV1Response

Extract text from Ezsigntemplatedocument area

Extract text from Ezsigntemplatedocument area

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\ObjectEzsigntemplatedocumentApi(
    // 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
);
$pkiEzsigntemplatedocumentID = 56; // int
$ezsigntemplatedocumentExtractTextV1Request = new \eZmaxAPI\Model\EzsigntemplatedocumentExtractTextV1Request(); // \eZmaxAPI\Model\EzsigntemplatedocumentExtractTextV1Request

try {
    $result = $apiInstance->ezsigntemplatedocumentExtractTextV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentExtractTextV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocumentExtractTextV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int
ezsigntemplatedocumentExtractTextV1Request \eZmaxAPI\Model\EzsigntemplatedocumentExtractTextV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentExtractTextV1Response

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]

ezsigntemplatedocumentFlattenV1()

ezsigntemplatedocumentFlattenV1($pkiEzsigntemplatedocumentID, $body): \eZmaxAPI\Model\EzsigntemplatedocumentFlattenV1Response

Flatten

Flatten an Ezsigntemplatedocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited.

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int
body object

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentFlattenV1Response

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]

ezsigntemplatedocumentGetEzsigntemplatedocumentpagerecognitionsV1()

ezsigntemplatedocumentGetEzsigntemplatedocumentpagerecognitionsV1($pkiEzsigntemplatedocumentID): \eZmaxAPI\Model\EzsigntemplatedocumentGetEzsigntemplatedocumentpagerecognitionsV1Response

Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpagerecognitions

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentGetEzsigntemplatedocumentpagerecognitionsV1Response

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]

ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1()

ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1($pkiEzsigntemplatedocumentID): \eZmaxAPI\Model\EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response

Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response

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]

ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1()

ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1($pkiEzsigntemplatedocumentID): \eZmaxAPI\Model\EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response

Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response

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]

ezsigntemplatedocumentGetEzsigntemplatesignaturesV2()

ezsigntemplatedocumentGetEzsigntemplatesignaturesV2($pkiEzsigntemplatedocumentID): \eZmaxAPI\Model\EzsigntemplatedocumentGetEzsigntemplatesignaturesV2Response

Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentGetEzsigntemplatesignaturesV2Response

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]

ezsigntemplatedocumentGetObjectV2()

ezsigntemplatedocumentGetObjectV2($pkiEzsigntemplatedocumentID): \eZmaxAPI\Model\EzsigntemplatedocumentGetObjectV2Response

Retrieve an existing Ezsigntemplatedocument

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentGetObjectV2Response

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]

ezsigntemplatedocumentGetWordsPositionsV1()

ezsigntemplatedocumentGetWordsPositionsV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentGetWordsPositionsV1Request): \eZmaxAPI\Model\EzsigntemplatedocumentGetWordsPositionsV1Response

Retrieve positions X,Y of given words from a Ezsigntemplatedocument

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\ObjectEzsigntemplatedocumentApi(
    // 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
);
$pkiEzsigntemplatedocumentID = 56; // int
$ezsigntemplatedocumentGetWordsPositionsV1Request = new \eZmaxAPI\Model\EzsigntemplatedocumentGetWordsPositionsV1Request(); // \eZmaxAPI\Model\EzsigntemplatedocumentGetWordsPositionsV1Request

try {
    $result = $apiInstance->ezsigntemplatedocumentGetWordsPositionsV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentGetWordsPositionsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocumentGetWordsPositionsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int
ezsigntemplatedocumentGetWordsPositionsV1Request \eZmaxAPI\Model\EzsigntemplatedocumentGetWordsPositionsV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentGetWordsPositionsV1Response

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]

ezsigntemplatedocumentPatchObjectV1()

ezsigntemplatedocumentPatchObjectV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentPatchObjectV1Request): \eZmaxAPI\Model\EzsigntemplatedocumentPatchObjectV1Response

Patch an existing Ezsigntemplatedocument

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\ObjectEzsigntemplatedocumentApi(
    // 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
);
$pkiEzsigntemplatedocumentID = 56; // int
$ezsigntemplatedocumentPatchObjectV1Request = new \eZmaxAPI\Model\EzsigntemplatedocumentPatchObjectV1Request(); // \eZmaxAPI\Model\EzsigntemplatedocumentPatchObjectV1Request

try {
    $result = $apiInstance->ezsigntemplatedocumentPatchObjectV1($pkiEzsigntemplatedocumentID, $ezsigntemplatedocumentPatchObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatedocumentApi->ezsigntemplatedocumentPatchObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID int
ezsigntemplatedocumentPatchObjectV1Request \eZmaxAPI\Model\EzsigntemplatedocumentPatchObjectV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatedocumentPatchObjectV1Response

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]