Skip to content

ObjectEzsignfoldertypeApi.md

Latest commit

 

History

History
403 lines (275 loc) · 14.2 KB

ObjectEzsignfoldertypeApi.md

File metadata and controls

403 lines (275 loc) · 14.2 KB

eZmaxAPI\ObjectEzsignfoldertypeApi

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
ezsignfoldertypeCreateObjectV3() POST /3/object/ezsignfoldertype Create a new Ezsignfoldertype
ezsignfoldertypeEditObjectV3() PUT /3/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Edit an existing Ezsignfoldertype
ezsignfoldertypeGetAutocompleteV2() GET /2/object/ezsignfoldertype/getAutocomplete/{sSelector} Retrieve Ezsignfoldertypes and IDs
ezsignfoldertypeGetListV1() GET /1/object/ezsignfoldertype/getList Retrieve Ezsignfoldertype list
ezsignfoldertypeGetObjectV2() GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype
ezsignfoldertypeGetObjectV4() GET /4/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype

ezsignfoldertypeCreateObjectV3()

ezsignfoldertypeCreateObjectV3($ezsignfoldertypeCreateObjectV3Request): \eZmaxAPI\Model\EzsignfoldertypeCreateObjectV3Response

Create a new Ezsignfoldertype

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\ObjectEzsignfoldertypeApi(
    // 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
);
$ezsignfoldertypeCreateObjectV3Request = new \eZmaxAPI\Model\EzsignfoldertypeCreateObjectV3Request(); // \eZmaxAPI\Model\EzsignfoldertypeCreateObjectV3Request

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

Parameters

Name Type Description Notes
ezsignfoldertypeCreateObjectV3Request \eZmaxAPI\Model\EzsignfoldertypeCreateObjectV3Request

Return type

\eZmaxAPI\Model\EzsignfoldertypeCreateObjectV3Response

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]

ezsignfoldertypeEditObjectV3()

ezsignfoldertypeEditObjectV3($pkiEzsignfoldertypeID, $ezsignfoldertypeEditObjectV3Request): \eZmaxAPI\Model\EzsignfoldertypeEditObjectV3Response

Edit an existing Ezsignfoldertype

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\ObjectEzsignfoldertypeApi(
    // 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
);
$pkiEzsignfoldertypeID = 56; // int
$ezsignfoldertypeEditObjectV3Request = new \eZmaxAPI\Model\EzsignfoldertypeEditObjectV3Request(); // \eZmaxAPI\Model\EzsignfoldertypeEditObjectV3Request

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

Parameters

Name Type Description Notes
pkiEzsignfoldertypeID int
ezsignfoldertypeEditObjectV3Request \eZmaxAPI\Model\EzsignfoldertypeEditObjectV3Request

Return type

\eZmaxAPI\Model\EzsignfoldertypeEditObjectV3Response

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]

ezsignfoldertypeGetAutocompleteV2()

ezsignfoldertypeGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage): \eZmaxAPI\Model\EzsignfoldertypeGetAutocompleteV2Response

Retrieve Ezsignfoldertypes and IDs

Get the list of Ezsignfoldertype 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\ObjectEzsignfoldertypeApi(
    // 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 Ezsignfoldertypes 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->ezsignfoldertypeGetAutocompleteV2($sSelector, $eFilterActive, $sQuery, $acceptLanguage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertypeGetAutocompleteV2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
sSelector string The type of Ezsignfoldertypes 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\EzsignfoldertypeGetAutocompleteV2Response

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]

ezsignfoldertypeGetListV1()

ezsignfoldertypeGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter): \eZmaxAPI\Model\EzsignfoldertypeGetListV1Response

Retrieve Ezsignfoldertype list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | 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\ObjectEzsignfoldertypeApi(
    // 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->ezsignfoldertypeGetListV1($eOrderBy, $iRowMax, $iRowOffset, $acceptLanguage, $sFilter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertypeGetListV1: ', $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\EzsignfoldertypeGetListV1Response

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]

ezsignfoldertypeGetObjectV2()

ezsignfoldertypeGetObjectV2($pkiEzsignfoldertypeID): \eZmaxAPI\Model\EzsignfoldertypeGetObjectV2Response

Retrieve an existing Ezsignfoldertype

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

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

Parameters

Name Type Description Notes
pkiEzsignfoldertypeID int

Return type

\eZmaxAPI\Model\EzsignfoldertypeGetObjectV2Response

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]

ezsignfoldertypeGetObjectV4()

ezsignfoldertypeGetObjectV4($pkiEzsignfoldertypeID): \eZmaxAPI\Model\EzsignfoldertypeGetObjectV4Response

Retrieve an existing Ezsignfoldertype

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

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

Parameters

Name Type Description Notes
pkiEzsignfoldertypeID int

Return type

\eZmaxAPI\Model\EzsignfoldertypeGetObjectV4Response

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]