Skip to content

Latest commit

 

History

History
261 lines (175 loc) · 9.1 KB

ObjectEzsigntemplatesignerApi.md

File metadata and controls

261 lines (175 loc) · 9.1 KB
Raw

eZmaxAPI\ObjectEzsigntemplatesignerApi

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
ezsigntemplatesignerCreateObjectV1() POST /1/object/ezsigntemplatesigner Create a new Ezsigntemplatesigner
ezsigntemplatesignerDeleteObjectV1() DELETE /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Delete an existing Ezsigntemplatesigner
ezsigntemplatesignerEditObjectV1() PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Edit an existing Ezsigntemplatesigner
ezsigntemplatesignerGetObjectV2() GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Retrieve an existing Ezsigntemplatesigner

ezsigntemplatesignerCreateObjectV1()

ezsigntemplatesignerCreateObjectV1($ezsigntemplatesignerCreateObjectV1Request): \eZmaxAPI\Model\EzsigntemplatesignerCreateObjectV1Response

Create a new Ezsigntemplatesigner

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\ObjectEzsigntemplatesignerApi(
    // 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
);
$ezsigntemplatesignerCreateObjectV1Request = new \eZmaxAPI\Model\EzsigntemplatesignerCreateObjectV1Request(); // \eZmaxAPI\Model\EzsigntemplatesignerCreateObjectV1Request

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

Parameters

Name Type Description Notes
ezsigntemplatesignerCreateObjectV1Request \eZmaxAPI\Model\EzsigntemplatesignerCreateObjectV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatesignerCreateObjectV1Response

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]

ezsigntemplatesignerDeleteObjectV1()

ezsigntemplatesignerDeleteObjectV1($pkiEzsigntemplatesignerID): \eZmaxAPI\Model\EzsigntemplatesignerDeleteObjectV1Response

Delete an existing Ezsigntemplatesigner

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatesignerID int

Return type

\eZmaxAPI\Model\EzsigntemplatesignerDeleteObjectV1Response

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]

ezsigntemplatesignerEditObjectV1()

ezsigntemplatesignerEditObjectV1($pkiEzsigntemplatesignerID, $ezsigntemplatesignerEditObjectV1Request): \eZmaxAPI\Model\EzsigntemplatesignerEditObjectV1Response

Edit an existing Ezsigntemplatesigner

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\ObjectEzsigntemplatesignerApi(
    // 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
);
$pkiEzsigntemplatesignerID = 56; // int
$ezsigntemplatesignerEditObjectV1Request = new \eZmaxAPI\Model\EzsigntemplatesignerEditObjectV1Request(); // \eZmaxAPI\Model\EzsigntemplatesignerEditObjectV1Request

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

Parameters

Name Type Description Notes
pkiEzsigntemplatesignerID int
ezsigntemplatesignerEditObjectV1Request \eZmaxAPI\Model\EzsigntemplatesignerEditObjectV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatesignerEditObjectV1Response

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]

ezsigntemplatesignerGetObjectV2()

ezsigntemplatesignerGetObjectV2($pkiEzsigntemplatesignerID): \eZmaxAPI\Model\EzsigntemplatesignerGetObjectV2Response

Retrieve an existing Ezsigntemplatesigner

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatesignerID int

Return type

\eZmaxAPI\Model\EzsigntemplatesignerGetObjectV2Response

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]