ObjectEzsigntemplatesignerApi.md

EZmaxApiDefinitionFull.ObjectEzsigntemplatesignerApi

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

Method	HTTP request	Description
ezsigntemplatesignerCreateObjectV1	POST /1/object/ezsigntemplatesigner	Create a new Ezsigntemplatesigner
ezsigntemplatesignerDeleteObjectV1	DELETE /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}	Delete an existing Ezsigntemplatesigner
ezsigntemplatesignerEditObjectV1	PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}	Edit an existing Ezsigntemplatesigner
ezsigntemplatesignerGetObjectV2	GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}	Retrieve an existing Ezsigntemplatesigner

ezsigntemplatesignerCreateObjectV1

EzsigntemplatesignerCreateObjectV1Response ezsigntemplatesignerCreateObjectV1(EzsigntemplatesignerCreateObjectV1Request)

Create a new Ezsigntemplatesigner

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.ObjectEzsigntemplatesignerApi();
let EzsigntemplatesignerCreateObjectV1Request = new EZmaxApiDefinitionFull.EzsigntemplatesignerCreateObjectV1Request(); // EzsigntemplatesignerCreateObjectV1Request | 
apiInstance.ezsigntemplatesignerCreateObjectV1(EzsigntemplatesignerCreateObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
EzsigntemplatesignerCreateObjectV1Request	EzsigntemplatesignerCreateObjectV1Request

Return type

EzsigntemplatesignerCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsigntemplatesignerDeleteObjectV1

EzsigntemplatesignerDeleteObjectV1Response ezsigntemplatesignerDeleteObjectV1(pkiEzsigntemplatesignerID)

Delete an existing Ezsigntemplatesigner

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.ObjectEzsigntemplatesignerApi();
let pkiEzsigntemplatesignerID = 56; // Number | 
apiInstance.ezsigntemplatesignerDeleteObjectV1(pkiEzsigntemplatesignerID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pkiEzsigntemplatesignerID	Number

Return type

EzsigntemplatesignerDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsigntemplatesignerEditObjectV1

EzsigntemplatesignerEditObjectV1Response ezsigntemplatesignerEditObjectV1(pkiEzsigntemplatesignerID, EzsigntemplatesignerEditObjectV1Request)

Edit an existing Ezsigntemplatesigner

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.ObjectEzsigntemplatesignerApi();
let pkiEzsigntemplatesignerID = 56; // Number | 
let EzsigntemplatesignerEditObjectV1Request = new EZmaxApiDefinitionFull.EzsigntemplatesignerEditObjectV1Request(); // EzsigntemplatesignerEditObjectV1Request | 
apiInstance.ezsigntemplatesignerEditObjectV1(pkiEzsigntemplatesignerID, EzsigntemplatesignerEditObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pkiEzsigntemplatesignerID	Number
EzsigntemplatesignerEditObjectV1Request	EzsigntemplatesignerEditObjectV1Request

Return type

EzsigntemplatesignerEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

ezsigntemplatesignerGetObjectV2

EzsigntemplatesignerGetObjectV2Response ezsigntemplatesignerGetObjectV2(pkiEzsigntemplatesignerID)

Retrieve an existing Ezsigntemplatesigner

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.ObjectEzsigntemplatesignerApi();
let pkiEzsigntemplatesignerID = 56; // Number | 
apiInstance.ezsigntemplatesignerGetObjectV2(pkiEzsigntemplatesignerID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pkiEzsigntemplatesignerID	Number

Return type

EzsigntemplatesignerGetObjectV2Response

Authorization

Authorization

HTTP request headers

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