Skip to content

Latest commit

 

History

History
510 lines (344 loc) · 17.4 KB

ObjectEzsignsignatureApi.md

File metadata and controls

510 lines (344 loc) · 17.4 KB
Raw

eZmaxAPI\ObjectEzsignsignatureApi

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
ezsignsignatureCreateObjectV1() POST /1/object/ezsignsignature Create a new Ezsignsignature
ezsignsignatureCreateObjectV2() POST /2/object/ezsignsignature Create a new Ezsignsignature
ezsignsignatureDeleteObjectV1() DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} Delete an existing Ezsignsignature
ezsignsignatureEditObjectV1() PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} Edit an existing Ezsignsignature
ezsignsignatureGetEzsignsignatureattachmentV1() GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment Retrieve an existing Ezsignsignature's Ezsignsignatureattachments
ezsignsignatureGetEzsignsignaturesAutomaticV1() GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic Retrieve all automatic Ezsignsignatures
ezsignsignatureGetObjectV2() GET /2/object/ezsignsignature/{pkiEzsignsignatureID} Retrieve an existing Ezsignsignature
ezsignsignatureSignV1() POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign Sign the Ezsignsignature

ezsignsignatureCreateObjectV1()

ezsignsignatureCreateObjectV1($ezsignsignatureCreateObjectV1Request): \eZmaxAPI\Model\EzsignsignatureCreateObjectV1Response

Create a new Ezsignsignature

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\ObjectEzsignsignatureApi(
    // 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
);
$ezsignsignatureCreateObjectV1Request = array(new \eZmaxAPI\Model\EzsignsignatureCreateObjectV1Request()); // \eZmaxAPI\Model\EzsignsignatureCreateObjectV1Request[]

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

Parameters

Name Type Description Notes
ezsignsignatureCreateObjectV1Request \eZmaxAPI\Model\EzsignsignatureCreateObjectV1Request[]

Return type

\eZmaxAPI\Model\EzsignsignatureCreateObjectV1Response

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]

ezsignsignatureCreateObjectV2()

ezsignsignatureCreateObjectV2($ezsignsignatureCreateObjectV2Request): \eZmaxAPI\Model\EzsignsignatureCreateObjectV2Response

Create a new Ezsignsignature

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\ObjectEzsignsignatureApi(
    // 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
);
$ezsignsignatureCreateObjectV2Request = new \eZmaxAPI\Model\EzsignsignatureCreateObjectV2Request(); // \eZmaxAPI\Model\EzsignsignatureCreateObjectV2Request

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

Parameters

Name Type Description Notes
ezsignsignatureCreateObjectV2Request \eZmaxAPI\Model\EzsignsignatureCreateObjectV2Request

Return type

\eZmaxAPI\Model\EzsignsignatureCreateObjectV2Response

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]

ezsignsignatureDeleteObjectV1()

ezsignsignatureDeleteObjectV1($pkiEzsignsignatureID): \eZmaxAPI\Model\EzsignsignatureDeleteObjectV1Response

Delete an existing Ezsignsignature

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

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

Parameters

Name Type Description Notes
pkiEzsignsignatureID int

Return type

\eZmaxAPI\Model\EzsignsignatureDeleteObjectV1Response

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]

ezsignsignatureEditObjectV1()

ezsignsignatureEditObjectV1($pkiEzsignsignatureID, $ezsignsignatureEditObjectV1Request): \eZmaxAPI\Model\EzsignsignatureEditObjectV1Response

Edit an existing Ezsignsignature

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\ObjectEzsignsignatureApi(
    // 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
);
$pkiEzsignsignatureID = 56; // int
$ezsignsignatureEditObjectV1Request = new \eZmaxAPI\Model\EzsignsignatureEditObjectV1Request(); // \eZmaxAPI\Model\EzsignsignatureEditObjectV1Request

try {
    $result = $apiInstance->ezsignsignatureEditObjectV1($pkiEzsignsignatureID, $ezsignsignatureEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignsignatureApi->ezsignsignatureEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignsignatureID int
ezsignsignatureEditObjectV1Request \eZmaxAPI\Model\EzsignsignatureEditObjectV1Request

Return type

\eZmaxAPI\Model\EzsignsignatureEditObjectV1Response

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]

ezsignsignatureGetEzsignsignatureattachmentV1()

ezsignsignatureGetEzsignsignatureattachmentV1($pkiEzsignsignatureID): \eZmaxAPI\Model\EzsignsignatureGetEzsignsignatureattachmentV1Response

Retrieve an existing Ezsignsignature's Ezsignsignatureattachments

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

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

Parameters

Name Type Description Notes
pkiEzsignsignatureID int

Return type

\eZmaxAPI\Model\EzsignsignatureGetEzsignsignatureattachmentV1Response

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]

ezsignsignatureGetEzsignsignaturesAutomaticV1()

ezsignsignatureGetEzsignsignaturesAutomaticV1(): \eZmaxAPI\Model\EzsignsignatureGetEzsignsignaturesAutomaticV1Response

Retrieve all automatic Ezsignsignatures

Return all the Ezsignsignatures that can be signed by the current user

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\ObjectEzsignsignatureApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\eZmaxAPI\Model\EzsignsignatureGetEzsignsignaturesAutomaticV1Response

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]

ezsignsignatureGetObjectV2()

ezsignsignatureGetObjectV2($pkiEzsignsignatureID): \eZmaxAPI\Model\EzsignsignatureGetObjectV2Response

Retrieve an existing Ezsignsignature

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

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

Parameters

Name Type Description Notes
pkiEzsignsignatureID int

Return type

\eZmaxAPI\Model\EzsignsignatureGetObjectV2Response

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]

ezsignsignatureSignV1()

ezsignsignatureSignV1($pkiEzsignsignatureID, $ezsignsignatureSignV1Request): \eZmaxAPI\Model\EzsignsignatureSignV1Response

Sign the Ezsignsignature

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\ObjectEzsignsignatureApi(
    // 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
);
$pkiEzsignsignatureID = 56; // int
$ezsignsignatureSignV1Request = new \eZmaxAPI\Model\EzsignsignatureSignV1Request(); // \eZmaxAPI\Model\EzsignsignatureSignV1Request

try {
    $result = $apiInstance->ezsignsignatureSignV1($pkiEzsignsignatureID, $ezsignsignatureSignV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignsignatureApi->ezsignsignatureSignV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignsignatureID int
ezsignsignatureSignV1Request \eZmaxAPI\Model\EzsignsignatureSignV1Request

Return type

\eZmaxAPI\Model\EzsignsignatureSignV1Response

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]