Skip to content

ObjectEzsignsigningreasonApi.md

Latest commit

 

History

History
340 lines (232 loc) · 12.6 KB

ObjectEzsignsigningreasonApi.md

File metadata and controls

340 lines (232 loc) · 12.6 KB

eZmaxAPI\ObjectEzsignsigningreasonApi

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
ezsignsigningreasonCreateObjectV1() POST /1/object/ezsignsigningreason Create a new Ezsignsigningreason
ezsignsigningreasonEditObjectV1() PUT /1/object/ezsignsigningreason/{pkiEzsignsigningreasonID} Edit an existing Ezsignsigningreason
ezsignsigningreasonGetAutocompleteV2() GET /2/object/ezsignsigningreason/getAutocomplete/{sSelector} Retrieve Ezsignsigningreasons and IDs
ezsignsigningreasonGetListV1() GET /1/object/ezsignsigningreason/getList Retrieve Ezsignsigningreason list
ezsignsigningreasonGetObjectV2() GET /2/object/ezsignsigningreason/{pkiEzsignsigningreasonID} Retrieve an existing Ezsignsigningreason

ezsignsigningreasonCreateObjectV1()

ezsignsigningreasonCreateObjectV1($ezsignsigningreasonCreateObjectV1Request): \eZmaxAPI\Model\EzsignsigningreasonCreateObjectV1Response

Create a new Ezsignsigningreason

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\ObjectEzsignsigningreasonApi(
    // 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
);
$ezsignsigningreasonCreateObjectV1Request = new \eZmaxAPI\Model\EzsignsigningreasonCreateObjectV1Request(); // \eZmaxAPI\Model\EzsignsigningreasonCreateObjectV1Request

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

Parameters

Name Type Description Notes
ezsignsigningreasonCreateObjectV1Request \eZmaxAPI\Model\EzsignsigningreasonCreateObjectV1Request

Return type

\eZmaxAPI\Model\EzsignsigningreasonCreateObjectV1Response

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]

ezsignsigningreasonEditObjectV1()

ezsignsigningreasonEditObjectV1($pkiEzsignsigningreasonID, $ezsignsigningreasonEditObjectV1Request): \eZmaxAPI\Model\EzsignsigningreasonEditObjectV1Response

Edit an existing Ezsignsigningreason

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\ObjectEzsignsigningreasonApi(
    // 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
);
$pkiEzsignsigningreasonID = 56; // int | The unique ID of the Ezsignsigningreason
$ezsignsigningreasonEditObjectV1Request = new \eZmaxAPI\Model\EzsignsigningreasonEditObjectV1Request(); // \eZmaxAPI\Model\EzsignsigningreasonEditObjectV1Request

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

Parameters

Name Type Description Notes
pkiEzsignsigningreasonID int The unique ID of the Ezsignsigningreason
ezsignsigningreasonEditObjectV1Request \eZmaxAPI\Model\EzsignsigningreasonEditObjectV1Request

Return type

\eZmaxAPI\Model\EzsignsigningreasonEditObjectV1Response

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]

ezsignsigningreasonGetAutocompleteV2()

ezsignsigningreasonGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage): \eZmaxAPI\Model\EzsignsigningreasonGetAutocompleteV2Response

Retrieve Ezsignsigningreasons and IDs

Get the list of Ezsignsigningreason 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\ObjectEzsignsigningreasonApi(
    // 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 Ezsignsigningreasons 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

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

Parameters

Name Type Description Notes
sSelector string The type of Ezsignsigningreasons 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]

Return type

\eZmaxAPI\Model\EzsignsigningreasonGetAutocompleteV2Response

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]

ezsignsigningreasonGetListV1()

ezsignsigningreasonGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\EzsignsigningreasonGetListV1Response

Retrieve Ezsignsigningreason list

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\ObjectEzsignsigningreasonApi(
    // 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->ezsignsigningreasonGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignsigningreasonApi->ezsignsigningreasonGetListV1: ', $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\EzsignsigningreasonGetListV1Response

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]

ezsignsigningreasonGetObjectV2()

ezsignsigningreasonGetObjectV2($pkiEzsignsigningreasonID): \eZmaxAPI\Model\EzsignsigningreasonGetObjectV2Response

Retrieve an existing Ezsignsigningreason

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\ObjectEzsignsigningreasonApi(
    // 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
);
$pkiEzsignsigningreasonID = 56; // int | The unique ID of the Ezsignsigningreason

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

Parameters

Name Type Description Notes
pkiEzsignsigningreasonID int The unique ID of the Ezsignsigningreason

Return type

\eZmaxAPI\Model\EzsignsigningreasonGetObjectV2Response

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]