ObjectUsergroupmembershipApi.md

EZmaxApiDefinitionFull.ObjectUsergroupmembershipApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

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

UsergroupmembershipCreateObjectV1Response usergroupmembershipCreateObjectV1(UsergroupmembershipCreateObjectV1Request)

Create a new Usergroupmembership

The endpoint allows to create one or many elements at once.

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUsergroupmembershipApi();
let UsergroupmembershipCreateObjectV1Request = new EZmaxApiDefinitionFull.UsergroupmembershipCreateObjectV1Request(); // UsergroupmembershipCreateObjectV1Request | 
apiInstance.usergroupmembershipCreateObjectV1(UsergroupmembershipCreateObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
UsergroupmembershipCreateObjectV1Request	UsergroupmembershipCreateObjectV1Request

Return type

UsergroupmembershipCreateObjectV1Response

Authorization

Authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

usergroupmembershipDeleteObjectV1

UsergroupmembershipDeleteObjectV1Response usergroupmembershipDeleteObjectV1(pkiUsergroupmembershipID)

Delete an existing Usergroupmembership

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUsergroupmembershipApi();
let pkiUsergroupmembershipID = 56; // Number | 
apiInstance.usergroupmembershipDeleteObjectV1(pkiUsergroupmembershipID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pkiUsergroupmembershipID	Number

Return type

UsergroupmembershipDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

usergroupmembershipEditObjectV1

UsergroupmembershipEditObjectV1Response usergroupmembershipEditObjectV1(pkiUsergroupmembershipID, UsergroupmembershipEditObjectV1Request)

Edit an existing Usergroupmembership

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUsergroupmembershipApi();
let pkiUsergroupmembershipID = 56; // Number | 
let UsergroupmembershipEditObjectV1Request = new EZmaxApiDefinitionFull.UsergroupmembershipEditObjectV1Request(); // UsergroupmembershipEditObjectV1Request | 
apiInstance.usergroupmembershipEditObjectV1(pkiUsergroupmembershipID, UsergroupmembershipEditObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pkiUsergroupmembershipID	Number
UsergroupmembershipEditObjectV1Request	UsergroupmembershipEditObjectV1Request

Return type

UsergroupmembershipEditObjectV1Response

Authorization

Authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

usergroupmembershipGetObjectV2

UsergroupmembershipGetObjectV2Response usergroupmembershipGetObjectV2(pkiUsergroupmembershipID)

Retrieve an existing Usergroupmembership

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let Authorization = defaultClient.authentications['Authorization'];
Authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.apiKeyPrefix = 'Token';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUsergroupmembershipApi();
let pkiUsergroupmembershipID = 56; // Number | 
apiInstance.usergroupmembershipGetObjectV2(pkiUsergroupmembershipID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pkiUsergroupmembershipID	Number

Return type

UsergroupmembershipGetObjectV2Response

Authorization

Authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json