Skip to content

Latest commit

 

History

History
135 lines (90 loc) · 4.36 KB

ObjectEzsignuserApi.md

File metadata and controls

135 lines (90 loc) · 4.36 KB

eZmaxAPI\ObjectEzsignuserApi

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
ezsignuserEditObjectV1() PUT /1/object/ezsignuser/{pkiEzsignuserID} Edit an existing Ezsignuser
ezsignuserGetObjectV2() GET /2/object/ezsignuser/{pkiEzsignuserID} Retrieve an existing Ezsignuser

ezsignuserEditObjectV1()

ezsignuserEditObjectV1($pkiEzsignuserID, $ezsignuserEditObjectV1Request): \eZmaxAPI\Model\EzsignuserEditObjectV1Response

Edit an existing Ezsignuser

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\ObjectEzsignuserApi(
    // 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
);
$pkiEzsignuserID = 56; // int | The unique ID of the Ezsignuser
$ezsignuserEditObjectV1Request = new \eZmaxAPI\Model\EzsignuserEditObjectV1Request(); // \eZmaxAPI\Model\EzsignuserEditObjectV1Request

try {
    $result = $apiInstance->ezsignuserEditObjectV1($pkiEzsignuserID, $ezsignuserEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignuserApi->ezsignuserEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignuserID int The unique ID of the Ezsignuser
ezsignuserEditObjectV1Request \eZmaxAPI\Model\EzsignuserEditObjectV1Request

Return type

\eZmaxAPI\Model\EzsignuserEditObjectV1Response

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]

ezsignuserGetObjectV2()

ezsignuserGetObjectV2($pkiEzsignuserID): \eZmaxAPI\Model\EzsignuserGetObjectV2Response

Retrieve an existing Ezsignuser

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\ObjectEzsignuserApi(
    // 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
);
$pkiEzsignuserID = 56; // int | The unique ID of the Ezsignuser

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

Parameters

Name Type Description Notes
pkiEzsignuserID int The unique ID of the Ezsignuser

Return type

\eZmaxAPI\Model\EzsignuserGetObjectV2Response

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]