Skip to content

Latest commit

 

History

History
468 lines (322 loc) · 18.1 KB

ObjectEzsigntemplatepackageApi.md

File metadata and controls

468 lines (322 loc) · 18.1 KB

eZmaxAPI\ObjectEzsigntemplatepackageApi

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
ezsigntemplatepackageCreateObjectV1() POST /1/object/ezsigntemplatepackage Create a new Ezsigntemplatepackage
ezsigntemplatepackageDeleteObjectV1() DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Delete an existing Ezsigntemplatepackage
ezsigntemplatepackageEditEzsigntemplatepackagesignersV1() PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners Edit multiple Ezsigntemplatepackagesigners
ezsigntemplatepackageEditObjectV1() PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Edit an existing Ezsigntemplatepackage
ezsigntemplatepackageGetAutocompleteV2() GET /2/object/ezsigntemplatepackage/getAutocomplete/{sSelector} Retrieve Ezsigntemplatepackages and IDs
ezsigntemplatepackageGetListV1() GET /1/object/ezsigntemplatepackage/getList Retrieve Ezsigntemplatepackage list
ezsigntemplatepackageGetObjectV2() GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Retrieve an existing Ezsigntemplatepackage

ezsigntemplatepackageCreateObjectV1()

ezsigntemplatepackageCreateObjectV1($ezsigntemplatepackageCreateObjectV1Request): \eZmaxAPI\Model\EzsigntemplatepackageCreateObjectV1Response

Create a new Ezsigntemplatepackage

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\ObjectEzsigntemplatepackageApi(
    // 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
);
$ezsigntemplatepackageCreateObjectV1Request = new \eZmaxAPI\Model\EzsigntemplatepackageCreateObjectV1Request(); // \eZmaxAPI\Model\EzsigntemplatepackageCreateObjectV1Request

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

Parameters

Name Type Description Notes
ezsigntemplatepackageCreateObjectV1Request \eZmaxAPI\Model\EzsigntemplatepackageCreateObjectV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatepackageCreateObjectV1Response

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]

ezsigntemplatepackageDeleteObjectV1()

ezsigntemplatepackageDeleteObjectV1($pkiEzsigntemplatepackageID): \eZmaxAPI\Model\EzsigntemplatepackageDeleteObjectV1Response

Delete an existing Ezsigntemplatepackage

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatepackageID int

Return type

\eZmaxAPI\Model\EzsigntemplatepackageDeleteObjectV1Response

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]

ezsigntemplatepackageEditEzsigntemplatepackagesignersV1()

ezsigntemplatepackageEditEzsigntemplatepackagesignersV1($pkiEzsigntemplatepackageID, $ezsigntemplatepackageEditEzsigntemplatepackagesignersV1Request): \eZmaxAPI\Model\EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response

Edit multiple Ezsigntemplatepackagesigners

Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners 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\ObjectEzsigntemplatepackageApi(
    // 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
);
$pkiEzsigntemplatepackageID = 56; // int
$ezsigntemplatepackageEditEzsigntemplatepackagesignersV1Request = new \eZmaxAPI\Model\EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request(); // \eZmaxAPI\Model\EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request

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

Parameters

Name Type Description Notes
pkiEzsigntemplatepackageID int
ezsigntemplatepackageEditEzsigntemplatepackagesignersV1Request \eZmaxAPI\Model\EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response

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]

ezsigntemplatepackageEditObjectV1()

ezsigntemplatepackageEditObjectV1($pkiEzsigntemplatepackageID, $ezsigntemplatepackageEditObjectV1Request): \eZmaxAPI\Model\EzsigntemplatepackageEditObjectV1Response

Edit an existing Ezsigntemplatepackage

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\ObjectEzsigntemplatepackageApi(
    // 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
);
$pkiEzsigntemplatepackageID = 56; // int
$ezsigntemplatepackageEditObjectV1Request = new \eZmaxAPI\Model\EzsigntemplatepackageEditObjectV1Request(); // \eZmaxAPI\Model\EzsigntemplatepackageEditObjectV1Request

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

Parameters

Name Type Description Notes
pkiEzsigntemplatepackageID int
ezsigntemplatepackageEditObjectV1Request \eZmaxAPI\Model\EzsigntemplatepackageEditObjectV1Request

Return type

\eZmaxAPI\Model\EzsigntemplatepackageEditObjectV1Response

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]

ezsigntemplatepackageGetAutocompleteV2()

ezsigntemplatepackageGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage, $fkiEzsignfoldertypeID): \eZmaxAPI\Model\EzsigntemplatepackageGetAutocompleteV2Response

Retrieve Ezsigntemplatepackages and IDs

Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete control.

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\ObjectEzsigntemplatepackageApi(
    // 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
);
$sSelector = 'sSelector_example'; // string | The type of Ezsigntemplatepackages to return
$eFilterActive = 'Active'; // string | Specify which results we want to display.
$sQuery = 'sQuery_example'; // string | Allow to filter the returned results
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$fkiEzsignfoldertypeID = 56; // int | The fkiEzsignfoldertypeID to use with the selector Ezsigntemplatepublic

try {
    $result = $apiInstance->ezsigntemplatepackageGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage, $fkiEzsignfoldertypeID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatepackageApi->ezsigntemplatepackageGetAutocompleteV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
sSelector string The type of Ezsigntemplatepackages to return
eFilterActive string Specify which results we want to display. [optional] [default to 'Active']
sQuery string Allow to filter the returned results [optional]
acceptLanguage \eZmaxAPI\Model\HeaderAcceptLanguage [optional]
fkiEzsignfoldertypeID int The fkiEzsignfoldertypeID to use with the selector Ezsigntemplatepublic [optional]

Return type

\eZmaxAPI\Model\EzsigntemplatepackageGetAutocompleteV2Response

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]

ezsigntemplatepackageGetListV1()

ezsigntemplatepackageGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\EzsigntemplatepackageGetListV1Response

Retrieve Ezsigntemplatepackage list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsigntemplatepackageType | Company
Team
User
Usergroup |

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\ObjectEzsigntemplatepackageApi(
    // 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
);
$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted
$iRowMax = 56; // int
$iRowOffset = 0; // int
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$sFilter = 'sFilter_example'; // string

try {
    $result = $apiInstance->ezsigntemplatepackageGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsigntemplatepackageApi->ezsigntemplatepackageGetListV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
eOrderBy string Specify how you want the results to be sorted [optional]
iRowMax int [optional]
iRowOffset int [optional] [default to 0]
acceptLanguage \eZmaxAPI\Model\HeaderAcceptLanguage [optional]
sFilter string [optional]

Return type

\eZmaxAPI\Model\EzsigntemplatepackageGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ezsigntemplatepackageGetObjectV2()

ezsigntemplatepackageGetObjectV2($pkiEzsigntemplatepackageID): \eZmaxAPI\Model\EzsigntemplatepackageGetObjectV2Response

Retrieve an existing Ezsigntemplatepackage

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

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

Parameters

Name Type Description Notes
pkiEzsigntemplatepackageID int

Return type

\eZmaxAPI\Model\EzsigntemplatepackageGetObjectV2Response

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]