Skip to content

Latest commit

 

History

History
261 lines (175 loc) · 9.01 KB

ObjectUsergroupmembershipApi.md

File metadata and controls

261 lines (175 loc) · 9.01 KB

eZmaxAPI\ObjectUsergroupmembershipApi

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
usergroupmembershipCreateObjectV1() POST /1/object/usergroupmembership Create a new Usergroupmembership
usergroupmembershipDeleteObjectV1() DELETE /1/object/usergroupmembership/{pkiUsergroupmembershipID} Delete an existing Usergroupmembership
usergroupmembershipEditObjectV1() PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} Edit an existing Usergroupmembership
usergroupmembershipGetObjectV2() GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} Retrieve an existing Usergroupmembership

usergroupmembershipCreateObjectV1()

usergroupmembershipCreateObjectV1($usergroupmembershipCreateObjectV1Request): \eZmaxAPI\Model\UsergroupmembershipCreateObjectV1Response

Create a new Usergroupmembership

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\ObjectUsergroupmembershipApi(
    // 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
);
$usergroupmembershipCreateObjectV1Request = new \eZmaxAPI\Model\UsergroupmembershipCreateObjectV1Request(); // \eZmaxAPI\Model\UsergroupmembershipCreateObjectV1Request

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

Parameters

Name Type Description Notes
usergroupmembershipCreateObjectV1Request \eZmaxAPI\Model\UsergroupmembershipCreateObjectV1Request

Return type

\eZmaxAPI\Model\UsergroupmembershipCreateObjectV1Response

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]

usergroupmembershipDeleteObjectV1()

usergroupmembershipDeleteObjectV1($pkiUsergroupmembershipID): \eZmaxAPI\Model\UsergroupmembershipDeleteObjectV1Response

Delete an existing Usergroupmembership

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

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

Parameters

Name Type Description Notes
pkiUsergroupmembershipID int

Return type

\eZmaxAPI\Model\UsergroupmembershipDeleteObjectV1Response

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]

usergroupmembershipEditObjectV1()

usergroupmembershipEditObjectV1($pkiUsergroupmembershipID, $usergroupmembershipEditObjectV1Request): \eZmaxAPI\Model\UsergroupmembershipEditObjectV1Response

Edit an existing Usergroupmembership

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\ObjectUsergroupmembershipApi(
    // 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
);
$pkiUsergroupmembershipID = 56; // int
$usergroupmembershipEditObjectV1Request = new \eZmaxAPI\Model\UsergroupmembershipEditObjectV1Request(); // \eZmaxAPI\Model\UsergroupmembershipEditObjectV1Request

try {
    $result = $apiInstance->usergroupmembershipEditObjectV1($pkiUsergroupmembershipID, $usergroupmembershipEditObjectV1Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ObjectUsergroupmembershipApi->usergroupmembershipEditObjectV1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
pkiUsergroupmembershipID int
usergroupmembershipEditObjectV1Request \eZmaxAPI\Model\UsergroupmembershipEditObjectV1Request

Return type

\eZmaxAPI\Model\UsergroupmembershipEditObjectV1Response

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]

usergroupmembershipGetObjectV2()

usergroupmembershipGetObjectV2($pkiUsergroupmembershipID): \eZmaxAPI\Model\UsergroupmembershipGetObjectV2Response

Retrieve an existing Usergroupmembership

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

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

Parameters

Name Type Description Notes
pkiUsergroupmembershipID int

Return type

\eZmaxAPI\Model\UsergroupmembershipGetObjectV2Response

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]