Skip to content

Latest commit

 

History

History
387 lines (262 loc) · 14.2 KB

ObjectEzsignsignergroupApi.md

File metadata and controls

387 lines (262 loc) · 14.2 KB
Raw

eZmaxAPI\ObjectEzsignsignergroupApi

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
ezsignsignergroupCreateObjectV1() POST /1/object/ezsignsignergroup Create a new Ezsignsignergroup
ezsignsignergroupDeleteObjectV1() DELETE /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} Delete an existing Ezsignsignergroup
ezsignsignergroupEditEzsignsignergroupmembershipsV1() PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships Edit multiple Ezsignsignergroupmemberships
ezsignsignergroupEditObjectV1() PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} Edit an existing Ezsignsignergroup
ezsignsignergroupGetEzsignsignergroupmembershipsV1() GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships
ezsignsignergroupGetObjectV2() GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID} Retrieve an existing Ezsignsignergroup

ezsignsignergroupCreateObjectV1()

ezsignsignergroupCreateObjectV1($ezsignsignergroupCreateObjectV1Request): \eZmaxAPI\Model\EzsignsignergroupCreateObjectV1Response

Create a new Ezsignsignergroup

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\ObjectEzsignsignergroupApi(
    // 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
);
$ezsignsignergroupCreateObjectV1Request = new \eZmaxAPI\Model\EzsignsignergroupCreateObjectV1Request(); // \eZmaxAPI\Model\EzsignsignergroupCreateObjectV1Request

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

Parameters

Name Type Description Notes
ezsignsignergroupCreateObjectV1Request \eZmaxAPI\Model\EzsignsignergroupCreateObjectV1Request

Return type

\eZmaxAPI\Model\EzsignsignergroupCreateObjectV1Response

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]

ezsignsignergroupDeleteObjectV1()

ezsignsignergroupDeleteObjectV1($pkiEzsignsignergroupID): \eZmaxAPI\Model\EzsignsignergroupDeleteObjectV1Response

Delete an existing Ezsignsignergroup

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\ObjectEzsignsignergroupApi(
    // 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
);
$pkiEzsignsignergroupID = 56; // int | The unique ID of the Ezsignsignergroup

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

Parameters

Name Type Description Notes
pkiEzsignsignergroupID int The unique ID of the Ezsignsignergroup

Return type

\eZmaxAPI\Model\EzsignsignergroupDeleteObjectV1Response

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]

ezsignsignergroupEditEzsignsignergroupmembershipsV1()

ezsignsignergroupEditEzsignsignergroupmembershipsV1($pkiEzsignsignergroupID, $ezsignsignergroupEditEzsignsignergroupmembershipsV1Request): \eZmaxAPI\Model\EzsignsignergroupEditEzsignsignergroupmembershipsV1Response

Edit multiple Ezsignsignergroupmemberships

Using this endpoint, you can edit multiple Ezsignsignergroupmemberships 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\ObjectEzsignsignergroupApi(
    // 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
);
$pkiEzsignsignergroupID = 56; // int
$ezsignsignergroupEditEzsignsignergroupmembershipsV1Request = new \eZmaxAPI\Model\EzsignsignergroupEditEzsignsignergroupmembershipsV1Request(); // \eZmaxAPI\Model\EzsignsignergroupEditEzsignsignergroupmembershipsV1Request

try {
    $result = $apiInstance->ezsignsignergroupEditEzsignsignergroupmembershipsV1($pkiEzsignsignergroupID, $ezsignsignergroupEditEzsignsignergroupmembershipsV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignsignergroupApi->ezsignsignergroupEditEzsignsignergroupmembershipsV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignsignergroupID int
ezsignsignergroupEditEzsignsignergroupmembershipsV1Request \eZmaxAPI\Model\EzsignsignergroupEditEzsignsignergroupmembershipsV1Request

Return type

\eZmaxAPI\Model\EzsignsignergroupEditEzsignsignergroupmembershipsV1Response

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]

ezsignsignergroupEditObjectV1()

ezsignsignergroupEditObjectV1($pkiEzsignsignergroupID, $ezsignsignergroupEditObjectV1Request): \eZmaxAPI\Model\EzsignsignergroupEditObjectV1Response

Edit an existing Ezsignsignergroup

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\ObjectEzsignsignergroupApi(
    // 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
);
$pkiEzsignsignergroupID = 56; // int | The unique ID of the Ezsignsignergroup
$ezsignsignergroupEditObjectV1Request = new \eZmaxAPI\Model\EzsignsignergroupEditObjectV1Request(); // \eZmaxAPI\Model\EzsignsignergroupEditObjectV1Request

try {
    $result = $apiInstance->ezsignsignergroupEditObjectV1($pkiEzsignsignergroupID, $ezsignsignergroupEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectEzsignsignergroupApi->ezsignsignergroupEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiEzsignsignergroupID int The unique ID of the Ezsignsignergroup
ezsignsignergroupEditObjectV1Request \eZmaxAPI\Model\EzsignsignergroupEditObjectV1Request

Return type

\eZmaxAPI\Model\EzsignsignergroupEditObjectV1Response

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]

ezsignsignergroupGetEzsignsignergroupmembershipsV1()

ezsignsignergroupGetEzsignsignergroupmembershipsV1($pkiEzsignsignergroupID): \eZmaxAPI\Model\EzsignsignergroupGetEzsignsignergroupmembershipsV1Response

Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships

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

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

Parameters

Name Type Description Notes
pkiEzsignsignergroupID int

Return type

\eZmaxAPI\Model\EzsignsignergroupGetEzsignsignergroupmembershipsV1Response

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]

ezsignsignergroupGetObjectV2()

ezsignsignergroupGetObjectV2($pkiEzsignsignergroupID): \eZmaxAPI\Model\EzsignsignergroupGetObjectV2Response

Retrieve an existing Ezsignsignergroup

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\ObjectEzsignsignergroupApi(
    // 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
);
$pkiEzsignsignergroupID = 56; // int | The unique ID of the Ezsignsignergroup

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

Parameters

Name Type Description Notes
pkiEzsignsignergroupID int The unique ID of the Ezsignsignergroup

Return type

\eZmaxAPI\Model\EzsignsignergroupGetObjectV2Response

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]