Skip to content

Latest commit

 

History

History
448 lines (299 loc) · 13.7 KB

ObjectSignatureApi.md

File metadata and controls

448 lines (299 loc) · 13.7 KB

eZmaxAPI\ObjectSignatureApi

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
signatureCreateObjectV1() POST /1/object/signature Create a new Signature
signatureDeleteObjectV1() DELETE /1/object/signature/{pkiSignatureID} Delete an existing Signature
signatureEditObjectV1() PUT /1/object/signature/{pkiSignatureID} Edit an existing Signature
signatureGetObjectV2() GET /2/object/signature/{pkiSignatureID} Retrieve an existing Signature
signatureGetObjectV3() GET /3/object/signature/{pkiSignatureID} Retrieve an existing Signature
signatureGetSVGInitialsV1() GET /1/object/signature/{pkiSignatureID}/getSVGInitials Retrieve an existing Signature initial SVG
signatureGetSVGSignatureV1() GET /1/object/signature/{pkiSignatureID}/getSVGSignature Retrieve an existing Signature SVG

signatureCreateObjectV1()

signatureCreateObjectV1($signatureCreateObjectV1Request): \eZmaxAPI\Model\SignatureCreateObjectV1Response

Create a new Signature

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\ObjectSignatureApi(
    // 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
);
$signatureCreateObjectV1Request = new \eZmaxAPI\Model\SignatureCreateObjectV1Request(); // \eZmaxAPI\Model\SignatureCreateObjectV1Request

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

Parameters

Name Type Description Notes
signatureCreateObjectV1Request \eZmaxAPI\Model\SignatureCreateObjectV1Request

Return type

\eZmaxAPI\Model\SignatureCreateObjectV1Response

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]

signatureDeleteObjectV1()

signatureDeleteObjectV1($pkiSignatureID): \eZmaxAPI\Model\SignatureDeleteObjectV1Response

Delete an existing 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\ObjectSignatureApi(
    // 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
);
$pkiSignatureID = 56; // int | The unique ID of the Signature

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

Parameters

Name Type Description Notes
pkiSignatureID int The unique ID of the Signature

Return type

\eZmaxAPI\Model\SignatureDeleteObjectV1Response

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]

signatureEditObjectV1()

signatureEditObjectV1($pkiSignatureID, $signatureEditObjectV1Request): \eZmaxAPI\Model\SignatureEditObjectV1Response

Edit an existing 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\ObjectSignatureApi(
    // 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
);
$pkiSignatureID = 56; // int | The unique ID of the Signature
$signatureEditObjectV1Request = new \eZmaxAPI\Model\SignatureEditObjectV1Request(); // \eZmaxAPI\Model\SignatureEditObjectV1Request

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

Parameters

Name Type Description Notes
pkiSignatureID int The unique ID of the Signature
signatureEditObjectV1Request \eZmaxAPI\Model\SignatureEditObjectV1Request

Return type

\eZmaxAPI\Model\SignatureEditObjectV1Response

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]

signatureGetObjectV2()

signatureGetObjectV2($pkiSignatureID): \eZmaxAPI\Model\SignatureGetObjectV2Response

Retrieve an existing 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\ObjectSignatureApi(
    // 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
);
$pkiSignatureID = 56; // int | The unique ID of the Signature

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

Parameters

Name Type Description Notes
pkiSignatureID int The unique ID of the Signature

Return type

\eZmaxAPI\Model\SignatureGetObjectV2Response

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]

signatureGetObjectV3()

signatureGetObjectV3($pkiSignatureID): \eZmaxAPI\Model\SignatureGetObjectV3Response

Retrieve an existing 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\ObjectSignatureApi(
    // 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
);
$pkiSignatureID = 56; // int | The unique ID of the Signature

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

Parameters

Name Type Description Notes
pkiSignatureID int The unique ID of the Signature

Return type

\eZmaxAPI\Model\SignatureGetObjectV3Response

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]

signatureGetSVGInitialsV1()

signatureGetSVGInitialsV1($pkiSignatureID)

Retrieve an existing Signature initial SVG

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\ObjectSignatureApi(
    // 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
);
$pkiSignatureID = 56; // int | The unique ID of the Signature

try {
    $apiInstance->signatureGetSVGInitialsV1($pkiSignatureID);
} catch (Exception $e) {
    echo 'Exception when calling ObjectSignatureApi->signatureGetSVGInitialsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiSignatureID int The unique ID of the Signature

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]

signatureGetSVGSignatureV1()

signatureGetSVGSignatureV1($pkiSignatureID)

Retrieve an existing Signature SVG

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\ObjectSignatureApi(
    // 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
);
$pkiSignatureID = 56; // int | The unique ID of the Signature

try {
    $apiInstance->signatureGetSVGSignatureV1($pkiSignatureID);
} catch (Exception $e) {
    echo 'Exception when calling ObjectSignatureApi->signatureGetSVGSignatureV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiSignatureID int The unique ID of the Signature

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]