Skip to content

ObjectEzsigntemplatesignatureApi.md

Latest commit

 

History

History
326 lines (218 loc) · 12.1 KB

ObjectEzsigntemplatesignatureApi.md

File metadata and controls

326 lines (218 loc) · 12.1 KB

eZmaxAPI\ObjectEzsigntemplatesignatureApi

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
ezsigntemplatesignatureCreateObjectV2() POST /2/object/ezsigntemplatesignature Create a new Ezsigntemplatesignature
ezsigntemplatesignatureCreateObjectV3() POST /3/object/ezsigntemplatesignature Create a new Ezsigntemplatesignature
ezsigntemplatesignatureDeleteObjectV1() DELETE /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Delete an existing Ezsigntemplatesignature
ezsigntemplatesignatureEditObjectV3() PUT /3/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Edit an existing Ezsigntemplatesignature
ezsigntemplatesignatureGetObjectV4() GET /4/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Retrieve an existing Ezsigntemplatesignature

ezsigntemplatesignatureCreateObjectV2()

ezsigntemplatesignatureCreateObjectV2($ezsigntemplatesignatureCreateObjectV2Request): \eZmaxAPI\Model\EzsigntemplatesignatureCreateObjectV2Response

Create a new Ezsigntemplatesignature

The endpoint allows to create one or many elements at once. 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\ObjectEzsigntemplatesignatureApi(
    // 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
);
$ezsigntemplatesignatureCreateObjectV2Request = new \eZmaxAPI\Model\EzsigntemplatesignatureCreateObjectV2Request(); // \eZmaxAPI\Model\EzsigntemplatesignatureCreateObjectV2Request

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

Parameters

Name Type Description Notes
ezsigntemplatesignatureCreateObjectV2Request \eZmaxAPI\Model\EzsigntemplatesignatureCreateObjectV2Request

Return type

\eZmaxAPI\Model\EzsigntemplatesignatureCreateObjectV2Response

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]

ezsigntemplatesignatureCreateObjectV3()

ezsigntemplatesignatureCreateObjectV3($ezsigntemplatesignatureCreateObjectV3Request): \eZmaxAPI\Model\EzsigntemplatesignatureCreateObjectV3Response

Create a new Ezsigntemplatesignature

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\ObjectEzsigntemplatesignatureApi(
    // 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
);
$ezsigntemplatesignatureCreateObjectV3Request = new \eZmaxAPI\Model\EzsigntemplatesignatureCreateObjectV3Request(); // \eZmaxAPI\Model\EzsigntemplatesignatureCreateObjectV3Request

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

Parameters

Name Type Description Notes
ezsigntemplatesignatureCreateObjectV3Request \eZmaxAPI\Model\EzsigntemplatesignatureCreateObjectV3Request

Return type

\eZmaxAPI\Model\EzsigntemplatesignatureCreateObjectV3Response

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]

ezsigntemplatesignatureDeleteObjectV1()

ezsigntemplatesignatureDeleteObjectV1($pkiEzsigntemplatesignatureID): \eZmaxAPI\Model\EzsigntemplatesignatureDeleteObjectV1Response

Delete an existing Ezsigntemplatesignature

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatesignatureID int

Return type

\eZmaxAPI\Model\EzsigntemplatesignatureDeleteObjectV1Response

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]

ezsigntemplatesignatureEditObjectV3()

ezsigntemplatesignatureEditObjectV3($pkiEzsigntemplatesignatureID, $ezsigntemplatesignatureEditObjectV3Request): \eZmaxAPI\Model\EzsigntemplatesignatureEditObjectV3Response

Edit an existing Ezsigntemplatesignature

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\ObjectEzsigntemplatesignatureApi(
    // 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
);
$pkiEzsigntemplatesignatureID = 56; // int
$ezsigntemplatesignatureEditObjectV3Request = new \eZmaxAPI\Model\EzsigntemplatesignatureEditObjectV3Request(); // \eZmaxAPI\Model\EzsigntemplatesignatureEditObjectV3Request

try {
    $result = $apiInstance->ezsigntemplatesignatureEditObjectV3($pkiEzsigntemplatesignatureID, $ezsigntemplatesignatureEditObjectV3Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatesignatureApi->ezsigntemplatesignatureEditObjectV3: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsigntemplatesignatureID int
ezsigntemplatesignatureEditObjectV3Request \eZmaxAPI\Model\EzsigntemplatesignatureEditObjectV3Request

Return type

\eZmaxAPI\Model\EzsigntemplatesignatureEditObjectV3Response

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]

ezsigntemplatesignatureGetObjectV4()

ezsigntemplatesignatureGetObjectV4($pkiEzsigntemplatesignatureID): \eZmaxAPI\Model\EzsigntemplatesignatureGetObjectV4Response

Retrieve an existing Ezsigntemplatesignature

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatesignatureID int

Return type

\eZmaxAPI\Model\EzsigntemplatesignatureGetObjectV4Response

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]