Skip to content
This repository has been archived by the owner on Apr 14, 2024. It is now read-only.

Latest commit

 

History

History
1650 lines (1597 loc) · 207 KB

README.md

File metadata and controls

1650 lines (1597 loc) · 207 KB

e_zmax_api_definition__full

EZmaxApiDefinitionFull - JavaScript client for e_zmax_api_definition__full This API expose all the functionnalities for the eZmax and eZsign applications. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.18
  • Package version: 1.1.18
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.ezmax.ca/en/contact

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install e_zmax_api_definition__full --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your e_zmax_api_definition__full from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/ezmaxinc/ezmax-sdk-javascript then install it via:

    npm install ezmaxinc/ezmax-sdk-javascript --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var EZmaxApiDefinitionFull = require('e_zmax_api_definition__full');


var api = new EZmaxApiDefinitionFull.GlobalCustomerApi()
var pksCustomerCode = "pksCustomerCode_example"; // {String} 
var opts = {
  'sInfrastructureproductCode': "sInfrastructureproductCode_example" // {String} The infrastructure product Code  If undefined, \"appcluster01\" is assumed
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.globalCustomerGetEndpointV1(pksCustomerCode, opts, callback);

Documentation for API Endpoints

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

Class Method HTTP request Description
EZmaxApiDefinitionFull.GlobalCustomerApi globalCustomerGetEndpointV1 GET /1/customer/{pksCustomerCode}/endpoint Get customer endpoint
EZmaxApiDefinitionFull.GlobalEzmaxclientApi globalEzmaxclientVersionV1 GET /1/ezmaxclient/{pksEzmaxclientOs}/version Retrieve the latest version of the Ezmaxclient
EZmaxApiDefinitionFull.GlobalEzmaxcustomerApi globalEzmaxcustomerGetConfigurationV1 GET /1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration Get ezmaxcustomer configuration
EZmaxApiDefinitionFull.ModuleEzsignApi ezsignSuggestSignersV1 GET /1/module/ezsign/suggestSigners Suggest signers
EZmaxApiDefinitionFull.ModuleEzsignApi ezsignSuggestTemplatesV1 GET /1/module/ezsign/suggestTemplates Suggest templates
EZmaxApiDefinitionFull.ModuleReportApi reportGetReportFromCacheV1 GET /1/module/report/getReportFromCache/{sReportgroupCacheID} Retrieve report from cache
EZmaxApiDefinitionFull.ModuleUserApi userCreateEzsignuserV1 POST /1/module/user/createezsignuser Create a new User of type Ezsignuser
EZmaxApiDefinitionFull.ObjectActivesessionApi activesessionGetCurrentV1 GET /1/object/activesession/getCurrent Get Current Activesession
EZmaxApiDefinitionFull.ObjectActivesessionApi activesessionGetListV1 GET /1/object/activesession/getList Retrieve Activesession list
EZmaxApiDefinitionFull.ObjectApikeyApi apikeyCreateObjectV2 POST /2/object/apikey Create a new Apikey
EZmaxApiDefinitionFull.ObjectApikeyApi apikeyEditObjectV1 PUT /1/object/apikey/{pkiApikeyID} Edit an existing Apikey
EZmaxApiDefinitionFull.ObjectApikeyApi apikeyEditPermissionsV1 PUT /1/object/apikey/{pkiApikeyID}/editPermissions Edit multiple Permissions
EZmaxApiDefinitionFull.ObjectApikeyApi apikeyGetObjectV2 GET /2/object/apikey/{pkiApikeyID} Retrieve an existing Apikey
EZmaxApiDefinitionFull.ObjectApikeyApi apikeyGetPermissionsV1 GET /1/object/apikey/{pkiApikeyID}/getPermissions Retrieve an existing Apikey's Permissions
EZmaxApiDefinitionFull.ObjectApikeyApi apikeyGetSubnetsV1 GET /1/object/apikey/{pkiApikeyID}/getSubnets Retrieve an existing Apikey's subnets
EZmaxApiDefinitionFull.ObjectBillingentityexternalApi billingentityexternalGetAutocompleteV2 GET /2/object/billingentityexternal/getAutocomplete/{sSelector} Retrieve Billingentityexternals and IDs
EZmaxApiDefinitionFull.ObjectBillingentityinternalApi billingentityinternalCreateObjectV1 POST /1/object/billingentityinternal Create a new Billingentityinternal
EZmaxApiDefinitionFull.ObjectBillingentityinternalApi billingentityinternalEditObjectV1 PUT /1/object/billingentityinternal/{pkiBillingentityinternalID} Edit an existing Billingentityinternal
EZmaxApiDefinitionFull.ObjectBillingentityinternalApi billingentityinternalGetAutocompleteV2 GET /2/object/billingentityinternal/getAutocomplete/{sSelector} Retrieve Billingentityinternals and IDs
EZmaxApiDefinitionFull.ObjectBillingentityinternalApi billingentityinternalGetListV1 GET /1/object/billingentityinternal/getList Retrieve Billingentityinternal list
EZmaxApiDefinitionFull.ObjectBillingentityinternalApi billingentityinternalGetObjectV2 GET /2/object/billingentityinternal/{pkiBillingentityinternalID} Retrieve an existing Billingentityinternal
EZmaxApiDefinitionFull.ObjectBrandingApi brandingCreateObjectV1 POST /1/object/branding Create a new Branding
EZmaxApiDefinitionFull.ObjectBrandingApi brandingEditObjectV1 PUT /1/object/branding/{pkiBrandingID} Edit an existing Branding
EZmaxApiDefinitionFull.ObjectBrandingApi brandingGetAutocompleteV2 GET /2/object/branding/getAutocomplete/{sSelector} Retrieve Brandings and IDs
EZmaxApiDefinitionFull.ObjectBrandingApi brandingGetListV1 GET /1/object/branding/getList Retrieve Branding list
EZmaxApiDefinitionFull.ObjectBrandingApi brandingGetObjectV2 GET /2/object/branding/{pkiBrandingID} Retrieve an existing Branding
EZmaxApiDefinitionFull.ObjectClonehistoryApi clonehistoryGetListV1 GET /1/object/clonehistory/getList Retrieve Clonehistory list
EZmaxApiDefinitionFull.ObjectCommunicationApi communicationGetObjectV2 GET /2/object/communication/{pkiCommunicationID} Retrieve an existing Communication
EZmaxApiDefinitionFull.ObjectCompanyApi companyGetAutocompleteV2 GET /2/object/company/getAutocomplete/{sSelector} Retrieve Companys and IDs
EZmaxApiDefinitionFull.ObjectDepartmentApi departmentGetAutocompleteV2 GET /2/object/department/getAutocomplete/{sSelector} Retrieve Departments and IDs
EZmaxApiDefinitionFull.ObjectEzmaxinvoicingApi ezmaxinvoicingGetAutocompleteV1 GET /1/object/ezmaxinvoicing/getAutocomplete/{sSelector} Retrieve Ezmaxinvoicings and IDs
EZmaxApiDefinitionFull.ObjectEzmaxinvoicingApi ezmaxinvoicingGetAutocompleteV2 GET /2/object/ezmaxinvoicing/getAutocomplete/{sSelector} Retrieve Ezmaxinvoicings and IDs
EZmaxApiDefinitionFull.ObjectEzmaxinvoicingApi ezmaxinvoicingGetObjectV2 GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID} Retrieve an existing Ezmaxinvoicing
EZmaxApiDefinitionFull.ObjectEzmaxinvoicingApi ezmaxinvoicingGetProvisionalV1 GET /1/object/ezmaxinvoicing/getProvisional Retrieve provisional Ezmaxinvoicing
EZmaxApiDefinitionFull.ObjectEzmaxproductApi ezmaxproductGetAutocompleteV2 GET /2/object/ezmaxproduct/getAutocomplete/{sSelector} Retrieve Ezmaxproducts and IDs
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendCreateEzsignbulksendtransmissionV1 POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission Create a new Ezsignbulksendtransmission in the Ezsignbulksend
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendCreateObjectV1 POST /1/object/ezsignbulksend Create a new Ezsignbulksend
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendDeleteObjectV1 DELETE /1/object/ezsignbulksend/{pkiEzsignbulksendID} Delete an existing Ezsignbulksend
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendEditObjectV1 PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} Edit an existing Ezsignbulksend
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendGetCsvTemplateV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getCsvTemplate Retrieve an existing Ezsignbulksend's empty Csv template
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendGetEzsignbulksendtransmissionsV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignbulksendtransmissions Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendGetFormsDataV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData Retrieve an existing Ezsignbulksend's forms data
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendGetListV1 GET /1/object/ezsignbulksend/getList Retrieve Ezsignbulksend list
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendGetObjectV2 GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} Retrieve an existing Ezsignbulksend
EZmaxApiDefinitionFull.ObjectEzsignbulksendApi ezsignbulksendReorderV1 POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend
EZmaxApiDefinitionFull.ObjectEzsignbulksenddocumentmappingApi ezsignbulksenddocumentmappingCreateObjectV1 POST /1/object/ezsignbulksenddocumentmapping Create a new Ezsignbulksenddocumentmapping
EZmaxApiDefinitionFull.ObjectEzsignbulksenddocumentmappingApi ezsignbulksenddocumentmappingDeleteObjectV1 DELETE /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} Delete an existing Ezsignbulksenddocumentmapping
EZmaxApiDefinitionFull.ObjectEzsignbulksenddocumentmappingApi ezsignbulksenddocumentmappingGetObjectV2 GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} Retrieve an existing Ezsignbulksenddocumentmapping
EZmaxApiDefinitionFull.ObjectEzsignbulksendsignermappingApi ezsignbulksendsignermappingCreateObjectV1 POST /1/object/ezsignbulksendsignermapping Create a new Ezsignbulksendsignermapping
EZmaxApiDefinitionFull.ObjectEzsignbulksendsignermappingApi ezsignbulksendsignermappingDeleteObjectV1 DELETE /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} Delete an existing Ezsignbulksendsignermapping
EZmaxApiDefinitionFull.ObjectEzsignbulksendsignermappingApi ezsignbulksendsignermappingGetObjectV2 GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} Retrieve an existing Ezsignbulksendsignermapping
EZmaxApiDefinitionFull.ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmissionGetCsvErrorsV1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getCsvErrors Retrieve an existing Ezsignbulksendtransmission's Csv containing errors
EZmaxApiDefinitionFull.ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmissionGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures
EZmaxApiDefinitionFull.ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmissionGetFormsDataV1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData Retrieve an existing Ezsignbulksendtransmission's forms data
EZmaxApiDefinitionFull.ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmissionGetObjectV2 GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} Retrieve an existing Ezsignbulksendtransmission
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentApplyEzsigntemplateV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate Apply an Ezsigntemplate to the Ezsigndocument.
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentApplyEzsigntemplateV2 POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate Apply an Ezsigntemplate to the Ezsigndocument.
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentCreateObjectV1 POST /1/object/ezsigndocument Create a new Ezsigndocument
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentCreateObjectV2 POST /2/object/ezsigndocument Create a new Ezsigndocument
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentDeclineToSignV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign Decline to sign
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentDeleteObjectV1 DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID} Delete an existing Ezsigndocument
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentEditEzsignformfieldgroupsV1 PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups Edit multiple Ezsignformfieldgroups
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentEditEzsignsignaturesV1 PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures Edit multiple Ezsignsignatures
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentEndPrematurelyV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely End prematurely
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentFlattenV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten Flatten
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetActionableElementsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements Retrieve actionable elements for the Ezsigndocument
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetCompletedElementsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements Retrieve completed elements for the Ezsigndocument
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetDownloadUrlV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} Retrieve a URL to download documents.
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetEzsignannotationsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations Retrieve an existing Ezsigndocument's Ezsignannotations
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetEzsignformfieldgroupsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups Retrieve an existing Ezsigndocument's Ezsignformfieldgroups
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetEzsignpagesV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages Retrieve an existing Ezsigndocument's Ezsignpages
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetEzsignsignaturesAutomaticV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsigndocument's automatic Ezsignsignatures
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetEzsignsignaturesV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures Retrieve an existing Ezsigndocument's Ezsignsignatures
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetFormDataV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData Retrieve an existing Ezsigndocument's Form Data
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetObjectV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetObjectV2 GET /2/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetTemporaryProofV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof Retrieve the temporary proof
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentGetWordsPositionsV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigndocument
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentPatchObjectV1 PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID} Patch an existing Ezsigndocument
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentSubmitEzsignformV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform Submit the Ezsignform
EZmaxApiDefinitionFull.ObjectEzsigndocumentApi ezsigndocumentUnsendV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend Unsend the Ezsigndocument
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderArchiveV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive Archive the Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderBatchDownloadV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload Download multiples files from an Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderCreateObjectV1 POST /1/object/ezsignfolder Create a new Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderCreateObjectV2 POST /2/object/ezsignfolder Create a new Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderDeleteObjectV1 DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} Delete an existing Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderDisposeEzsignfoldersV1 POST /1/object/ezsignfolder/disposeEzsignfolders Dispose Ezsignfolders
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderDisposeV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose Dispose the Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderEditObjectV1 PUT /1/object/ezsignfolder/{pkiEzsignfolderID} Edit an existing Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderGetActionableElementsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements Retrieve actionable elements for the Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderGetCommunicationCountV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount Retrieve Communication count
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderGetCommunicationListV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList Retrieve Communication list
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderGetEzsigndocumentsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments Retrieve an existing Ezsignfolder's Ezsigndocuments
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderGetEzsignfoldersignerassociationsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderGetFormsDataV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData Retrieve an existing Ezsignfolder's forms data
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderGetListV1 GET /1/object/ezsignfolder/getList Retrieve Ezsignfolder list
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderGetObjectV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderGetObjectV2 GET /2/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderImportEzsignfoldersignerassociationsV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderImportEzsigntemplatepackageV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage Import an Ezsigntemplatepackage in the Ezsignfolder.
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderReorderV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder Reorder Ezsigndocuments in the Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderSendV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderSendV2 POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderSendV3 POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
EZmaxApiDefinitionFull.ObjectEzsignfolderApi ezsignfolderUnsendV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend Unsend the Ezsignfolder
EZmaxApiDefinitionFull.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationCreateObjectV1 POST /1/object/ezsignfoldersignerassociation Create a new Ezsignfoldersignerassociation
EZmaxApiDefinitionFull.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationCreateObjectV2 POST /2/object/ezsignfoldersignerassociation Create a new Ezsignfoldersignerassociation
EZmaxApiDefinitionFull.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationDeleteObjectV1 DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Delete an existing Ezsignfoldersignerassociation
EZmaxApiDefinitionFull.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationEditObjectV1 PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Edit an existing Ezsignfoldersignerassociation
EZmaxApiDefinitionFull.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationForceDisconnectV1 POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/forceDisconnect Disconnects the Ezsignfoldersignerassociation
EZmaxApiDefinitionFull.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetInPersonLoginUrlV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getInPersonLoginUrl Retrieve a Login Url to allow In-Person signing
EZmaxApiDefinitionFull.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetObjectV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Retrieve an existing Ezsignfoldersignerassociation
EZmaxApiDefinitionFull.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetObjectV2 GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Retrieve an existing Ezsignfoldersignerassociation
EZmaxApiDefinitionFull.ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationPatchObjectV1 PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Patch an existing Ezsignfoldersignerassociation
EZmaxApiDefinitionFull.ObjectEzsignfoldertypeApi ezsignfoldertypeCreateObjectV1 POST /1/object/ezsignfoldertype Create a new Ezsignfoldertype
EZmaxApiDefinitionFull.ObjectEzsignfoldertypeApi ezsignfoldertypeEditObjectV1 PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Edit an existing Ezsignfoldertype
EZmaxApiDefinitionFull.ObjectEzsignfoldertypeApi ezsignfoldertypeGetAutocompleteV1 GET /1/object/ezsignfoldertype/getAutocomplete/{sSelector} Retrieve Ezsignfoldertypes and IDs
EZmaxApiDefinitionFull.ObjectEzsignfoldertypeApi ezsignfoldertypeGetAutocompleteV2 GET /2/object/ezsignfoldertype/getAutocomplete/{sSelector} Retrieve Ezsignfoldertypes and IDs
EZmaxApiDefinitionFull.ObjectEzsignfoldertypeApi ezsignfoldertypeGetListV1 GET /1/object/ezsignfoldertype/getList Retrieve Ezsignfoldertype list
EZmaxApiDefinitionFull.ObjectEzsignfoldertypeApi ezsignfoldertypeGetObjectV2 GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype
EZmaxApiDefinitionFull.ObjectEzsignformfieldgroupApi ezsignformfieldgroupCreateObjectV1 POST /1/object/ezsignformfieldgroup Create a new Ezsignformfieldgroup
EZmaxApiDefinitionFull.ObjectEzsignformfieldgroupApi ezsignformfieldgroupDeleteObjectV1 DELETE /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} Delete an existing Ezsignformfieldgroup
EZmaxApiDefinitionFull.ObjectEzsignformfieldgroupApi ezsignformfieldgroupEditObjectV1 PUT /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} Edit an existing Ezsignformfieldgroup
EZmaxApiDefinitionFull.ObjectEzsignformfieldgroupApi ezsignformfieldgroupGetObjectV2 GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} Retrieve an existing Ezsignformfieldgroup
EZmaxApiDefinitionFull.ObjectEzsignpageApi ezsignpageConsultV1 POST /1/object/ezsignpage/{pkiEzsignpageID}/consult Consult an Ezsignpage
EZmaxApiDefinitionFull.ObjectEzsignsignatureApi ezsignsignatureCreateObjectV1 POST /1/object/ezsignsignature Create a new Ezsignsignature
EZmaxApiDefinitionFull.ObjectEzsignsignatureApi ezsignsignatureCreateObjectV2 POST /2/object/ezsignsignature Create a new Ezsignsignature
EZmaxApiDefinitionFull.ObjectEzsignsignatureApi ezsignsignatureDeleteObjectV1 DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} Delete an existing Ezsignsignature
EZmaxApiDefinitionFull.ObjectEzsignsignatureApi ezsignsignatureEditObjectV1 PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} Edit an existing Ezsignsignature
EZmaxApiDefinitionFull.ObjectEzsignsignatureApi ezsignsignatureGetEzsignsignatureattachmentV1 GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment Retrieve an existing Ezsignsignature's Ezsignsignatureattachments
EZmaxApiDefinitionFull.ObjectEzsignsignatureApi ezsignsignatureGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic Retrieve all automatic Ezsignsignatures
EZmaxApiDefinitionFull.ObjectEzsignsignatureApi ezsignsignatureGetObjectV2 GET /2/object/ezsignsignature/{pkiEzsignsignatureID} Retrieve an existing Ezsignsignature
EZmaxApiDefinitionFull.ObjectEzsignsignatureApi ezsignsignatureSignV1 POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign Sign the Ezsignsignature
EZmaxApiDefinitionFull.ObjectEzsigntemplateApi ezsigntemplateCopyV1 POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy Copy the Ezsigntemplate
EZmaxApiDefinitionFull.ObjectEzsigntemplateApi ezsigntemplateCreateObjectV1 POST /1/object/ezsigntemplate Create a new Ezsigntemplate
EZmaxApiDefinitionFull.ObjectEzsigntemplateApi ezsigntemplateDeleteObjectV1 DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID} Delete an existing Ezsigntemplate
EZmaxApiDefinitionFull.ObjectEzsigntemplateApi ezsigntemplateEditObjectV1 PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID} Edit an existing Ezsigntemplate
EZmaxApiDefinitionFull.ObjectEzsigntemplateApi ezsigntemplateGetAutocompleteV2 GET /2/object/ezsigntemplate/getAutocomplete/{sSelector} Retrieve Ezsigntemplates and IDs
EZmaxApiDefinitionFull.ObjectEzsigntemplateApi ezsigntemplateGetListV1 GET /1/object/ezsigntemplate/getList Retrieve Ezsigntemplate list
EZmaxApiDefinitionFull.ObjectEzsigntemplateApi ezsigntemplateGetObjectV1 GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} Retrieve an existing Ezsigntemplate
EZmaxApiDefinitionFull.ObjectEzsigntemplateApi ezsigntemplateGetObjectV2 GET /2/object/ezsigntemplate/{pkiEzsigntemplateID} Retrieve an existing Ezsigntemplate
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentCreateObjectV1 POST /1/object/ezsigntemplatedocument Create a new Ezsigntemplatedocument
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups Edit multiple Ezsigntemplateformfieldgroups
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentEditEzsigntemplatesignaturesV1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures Edit multiple Ezsigntemplatesignatures
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentEditObjectV1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Edit an existing Ezsigntemplatedocument
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentFlattenV1 POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten Flatten
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplateformfieldgroups Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentGetEzsigntemplatesignaturesV1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentGetObjectV2 GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Retrieve an existing Ezsigntemplatedocument
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentGetWordsPositionsV1 POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigntemplatedocument
EZmaxApiDefinitionFull.ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentPatchObjectV1 PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Patch an existing Ezsigntemplatedocument
EZmaxApiDefinitionFull.ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroupCreateObjectV1 POST /1/object/ezsigntemplateformfieldgroup Create a new Ezsigntemplateformfieldgroup
EZmaxApiDefinitionFull.ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroupDeleteObjectV1 DELETE /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} Delete an existing Ezsigntemplateformfieldgroup
EZmaxApiDefinitionFull.ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroupEditObjectV1 PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} Edit an existing Ezsigntemplateformfieldgroup
EZmaxApiDefinitionFull.ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroupGetObjectV2 GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} Retrieve an existing Ezsigntemplateformfieldgroup
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackageApi ezsigntemplatepackageCreateObjectV1 POST /1/object/ezsigntemplatepackage Create a new Ezsigntemplatepackage
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackageApi ezsigntemplatepackageDeleteObjectV1 DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Delete an existing Ezsigntemplatepackage
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackageApi ezsigntemplatepackageEditEzsigntemplatepackagesignersV1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners Edit multiple Ezsigntemplatepackagesigners
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackageApi ezsigntemplatepackageEditObjectV1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Edit an existing Ezsigntemplatepackage
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackageApi ezsigntemplatepackageGetAutocompleteV2 GET /2/object/ezsigntemplatepackage/getAutocomplete/{sSelector} Retrieve Ezsigntemplatepackages and IDs
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackageApi ezsigntemplatepackageGetListV1 GET /1/object/ezsigntemplatepackage/getList Retrieve Ezsigntemplatepackage list
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackageApi ezsigntemplatepackageGetObjectV2 GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Retrieve an existing Ezsigntemplatepackage
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackagemembershipApi ezsigntemplatepackagemembershipCreateObjectV1 POST /1/object/ezsigntemplatepackagemembership Create a new Ezsigntemplatepackagemembership
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackagemembershipApi ezsigntemplatepackagemembershipDeleteObjectV1 DELETE /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} Delete an existing Ezsigntemplatepackagemembership
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackagemembershipApi ezsigntemplatepackagemembershipGetObjectV2 GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} Retrieve an existing Ezsigntemplatepackagemembership
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesignerCreateObjectV1 POST /1/object/ezsigntemplatepackagesigner Create a new Ezsigntemplatepackagesigner
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesignerDeleteObjectV1 DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} Delete an existing Ezsigntemplatepackagesigner
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesignerEditObjectV1 PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} Edit an existing Ezsigntemplatepackagesigner
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesignerGetObjectV2 GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} Retrieve an existing Ezsigntemplatepackagesigner
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackagesignermembershipApi ezsigntemplatepackagesignermembershipCreateObjectV1 POST /1/object/ezsigntemplatepackagesignermembership Create a new Ezsigntemplatepackagesignermembership
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackagesignermembershipApi ezsigntemplatepackagesignermembershipDeleteObjectV1 DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} Delete an existing Ezsigntemplatepackagesignermembership
EZmaxApiDefinitionFull.ObjectEzsigntemplatepackagesignermembershipApi ezsigntemplatepackagesignermembershipGetObjectV2 GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} Retrieve an existing Ezsigntemplatepackagesignermembership
EZmaxApiDefinitionFull.ObjectEzsigntemplatesignatureApi ezsigntemplatesignatureCreateObjectV1 POST /1/object/ezsigntemplatesignature Create a new Ezsigntemplatesignature
EZmaxApiDefinitionFull.ObjectEzsigntemplatesignatureApi ezsigntemplatesignatureDeleteObjectV1 DELETE /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Delete an existing Ezsigntemplatesignature
EZmaxApiDefinitionFull.ObjectEzsigntemplatesignatureApi ezsigntemplatesignatureEditObjectV1 PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Edit an existing Ezsigntemplatesignature
EZmaxApiDefinitionFull.ObjectEzsigntemplatesignatureApi ezsigntemplatesignatureGetObjectV2 GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Retrieve an existing Ezsigntemplatesignature
EZmaxApiDefinitionFull.ObjectEzsigntemplatesignerApi ezsigntemplatesignerCreateObjectV1 POST /1/object/ezsigntemplatesigner Create a new Ezsigntemplatesigner
EZmaxApiDefinitionFull.ObjectEzsigntemplatesignerApi ezsigntemplatesignerDeleteObjectV1 DELETE /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Delete an existing Ezsigntemplatesigner
EZmaxApiDefinitionFull.ObjectEzsigntemplatesignerApi ezsigntemplatesignerEditObjectV1 PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Edit an existing Ezsigntemplatesigner
EZmaxApiDefinitionFull.ObjectEzsigntemplatesignerApi ezsigntemplatesignerGetObjectV2 GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Retrieve an existing Ezsigntemplatesigner
EZmaxApiDefinitionFull.ObjectEzsigntsarequirementApi ezsigntsarequirementGetAutocompleteV2 GET /2/object/ezsigntsarequirement/getAutocomplete/{sSelector} Retrieve Ezsigntsarequirements and IDs
EZmaxApiDefinitionFull.ObjectFontApi fontGetAutocompleteV2 GET /2/object/font/getAutocomplete/{sSelector} Retrieve Fonts and IDs
EZmaxApiDefinitionFull.ObjectFranchisebrokerApi franchisebrokerGetAutocompleteV1 GET /1/object/franchisebroker/getAutocomplete/{sSelector} Retrieve Franchisebrokers and IDs
EZmaxApiDefinitionFull.ObjectFranchisebrokerApi franchisebrokerGetAutocompleteV2 GET /2/object/franchisebroker/getAutocomplete/{sSelector} Retrieve Franchisebrokers and IDs
EZmaxApiDefinitionFull.ObjectFranchiseofficeApi franchiseofficeGetAutocompleteV2 GET /2/object/franchiseoffice/getAutocomplete/{sSelector} Retrieve Franchiseoffices and IDs
EZmaxApiDefinitionFull.ObjectFranchisereferalincomeApi franchisereferalincomeCreateObjectV1 POST /1/object/franchisereferalincome Create a new Franchisereferalincome
EZmaxApiDefinitionFull.ObjectFranchisereferalincomeApi franchisereferalincomeCreateObjectV2 POST /2/object/franchisereferalincome Create a new Franchisereferalincome
EZmaxApiDefinitionFull.ObjectModulegroupApi modulegroupGetAllV1 GET /1/object/modulegroup/getAll/{eContext} Retrieve all Modulegroups
EZmaxApiDefinitionFull.ObjectNotificationsectionApi notificationsectionGetNotificationtestsV1 GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests Retrieve an existing Notificationsection's Notificationtests
EZmaxApiDefinitionFull.ObjectNotificationtestApi notificationtestGetElementsV1 GET /1/object/notificationtest/{pkiNotificationtestID}/getElements Retrieve an existing Notificationtest's Elements
EZmaxApiDefinitionFull.ObjectPaymenttermApi paymenttermCreateObjectV1 POST /1/object/paymentterm Create a new Paymentterm
EZmaxApiDefinitionFull.ObjectPaymenttermApi paymenttermEditObjectV1 PUT /1/object/paymentterm/{pkiPaymenttermID} Edit an existing Paymentterm
EZmaxApiDefinitionFull.ObjectPaymenttermApi paymenttermGetAutocompleteV2 GET /2/object/paymentterm/getAutocomplete/{sSelector} Retrieve Paymentterms and IDs
EZmaxApiDefinitionFull.ObjectPaymenttermApi paymenttermGetListV1 GET /1/object/paymentterm/getList Retrieve Paymentterm list
EZmaxApiDefinitionFull.ObjectPaymenttermApi paymenttermGetObjectV2 GET /2/object/paymentterm/{pkiPaymenttermID} Retrieve an existing Paymentterm
EZmaxApiDefinitionFull.ObjectPeriodApi periodGetAutocompleteV1 GET /1/object/period/getAutocomplete/{sSelector} Retrieve Periods and IDs
EZmaxApiDefinitionFull.ObjectPeriodApi periodGetAutocompleteV2 GET /2/object/period/getAutocomplete/{sSelector} Retrieve Periods and IDs
EZmaxApiDefinitionFull.ObjectPermissionApi permissionCreateObjectV1 POST /1/object/permission Create a new Permission
EZmaxApiDefinitionFull.ObjectPermissionApi permissionDeleteObjectV1 DELETE /1/object/permission/{pkiPermissionID} Delete an existing Permission
EZmaxApiDefinitionFull.ObjectPermissionApi permissionEditObjectV1 PUT /1/object/permission/{pkiPermissionID} Edit an existing Permission
EZmaxApiDefinitionFull.ObjectPermissionApi permissionGetObjectV2 GET /2/object/permission/{pkiPermissionID} Retrieve an existing Permission
EZmaxApiDefinitionFull.ObjectSecretquestionApi secretquestionGetAutocompleteV2 GET /2/object/secretquestion/getAutocomplete/{sSelector} Retrieve Secretquestions and IDs
EZmaxApiDefinitionFull.ObjectSessionhistoryApi sessionhistoryGetListV1 GET /1/object/sessionhistory/getList Retrieve Sessionhistory list
EZmaxApiDefinitionFull.ObjectSignatureApi signatureCreateObjectV1 POST /1/object/signature Create a new Signature
EZmaxApiDefinitionFull.ObjectSignatureApi signatureDeleteObjectV1 DELETE /1/object/signature/{pkiSignatureID} Delete an existing Signature
EZmaxApiDefinitionFull.ObjectSignatureApi signatureEditObjectV1 PUT /1/object/signature/{pkiSignatureID} Edit an existing Signature
EZmaxApiDefinitionFull.ObjectSignatureApi signatureGetObjectV2 GET /2/object/signature/{pkiSignatureID} Retrieve an existing Signature
EZmaxApiDefinitionFull.ObjectSubnetApi subnetCreateObjectV1 POST /1/object/subnet Create a new Subnet
EZmaxApiDefinitionFull.ObjectSubnetApi subnetDeleteObjectV1 DELETE /1/object/subnet/{pkiSubnetID} Delete an existing Subnet
EZmaxApiDefinitionFull.ObjectSubnetApi subnetEditObjectV1 PUT /1/object/subnet/{pkiSubnetID} Edit an existing Subnet
EZmaxApiDefinitionFull.ObjectSubnetApi subnetGetObjectV2 GET /2/object/subnet/{pkiSubnetID} Retrieve an existing Subnet
EZmaxApiDefinitionFull.ObjectSystemconfigurationApi systemconfigurationEditObjectV1 PUT /1/object/systemconfiguration/{pkiSystemconfigurationID} Edit an existing Systemconfiguration
EZmaxApiDefinitionFull.ObjectSystemconfigurationApi systemconfigurationGetObjectV2 GET /2/object/systemconfiguration/{pkiSystemconfigurationID} Retrieve an existing Systemconfiguration
EZmaxApiDefinitionFull.ObjectTaxassignmentApi taxassignmentGetAutocompleteV2 GET /2/object/taxassignment/getAutocomplete/{sSelector} Retrieve Taxassignments and IDs
EZmaxApiDefinitionFull.ObjectTimezoneApi timezoneGetAutocompleteV2 GET /2/object/timezone/getAutocomplete/{sSelector} Retrieve Timezones and IDs
EZmaxApiDefinitionFull.ObjectUserApi userCreateObjectV1 POST /1/object/user Create a new User
EZmaxApiDefinitionFull.ObjectUserApi userEditObjectV1 PUT /1/object/user/{pkiUserID} Edit an existing User
EZmaxApiDefinitionFull.ObjectUserApi userEditPermissionsV1 PUT /1/object/user/{pkiUserID}/editPermissions Edit multiple Permissions
EZmaxApiDefinitionFull.ObjectUserApi userGetAutocompleteV2 GET /2/object/user/getAutocomplete/{sSelector} Retrieve Users and IDs
EZmaxApiDefinitionFull.ObjectUserApi userGetEffectivePermissionsV1 GET /1/object/user/{pkiUserID}/getEffectivePermissions Retrieve an existing User's Effective Permissions
EZmaxApiDefinitionFull.ObjectUserApi userGetListV1 GET /1/object/user/getList Retrieve User list
EZmaxApiDefinitionFull.ObjectUserApi userGetObjectV2 GET /2/object/user/{pkiUserID} Retrieve an existing User
EZmaxApiDefinitionFull.ObjectUserApi userGetPermissionsV1 GET /1/object/user/{pkiUserID}/getPermissions Retrieve an existing User's Permissions
EZmaxApiDefinitionFull.ObjectUserApi userGetSubnetsV1 GET /1/object/user/{pkiUserID}/getSubnets Retrieve an existing User's Subnets
EZmaxApiDefinitionFull.ObjectUsergroupApi usergroupCreateObjectV1 POST /1/object/usergroup Create a new Usergroup
EZmaxApiDefinitionFull.ObjectUsergroupApi usergroupEditObjectV1 PUT /1/object/usergroup/{pkiUsergroupID} Edit an existing Usergroup
EZmaxApiDefinitionFull.ObjectUsergroupApi usergroupEditPermissionsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions Edit multiple Permissions
EZmaxApiDefinitionFull.ObjectUsergroupApi usergroupEditUsergroupmembershipsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships Edit multiple Usergroupmemberships
EZmaxApiDefinitionFull.ObjectUsergroupApi usergroupGetAutocompleteV2 GET /2/object/usergroup/getAutocomplete/{sSelector} Retrieve Usergroups and IDs
EZmaxApiDefinitionFull.ObjectUsergroupApi usergroupGetListV1 GET /1/object/usergroup/getList Retrieve Usergroup list
EZmaxApiDefinitionFull.ObjectUsergroupApi usergroupGetObjectV2 GET /2/object/usergroup/{pkiUsergroupID} Retrieve an existing Usergroup
EZmaxApiDefinitionFull.ObjectUsergroupApi usergroupGetPermissionsV1 GET /1/object/usergroup/{pkiUsergroupID}/getPermissions Retrieve an existing Usergroup's Permissions
EZmaxApiDefinitionFull.ObjectUsergroupApi usergroupGetUsergroupmembershipsV1 GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships Retrieve an existing Usergroup's Usergroupmemberships
EZmaxApiDefinitionFull.ObjectUsergroupmembershipApi usergroupmembershipCreateObjectV1 POST /1/object/usergroupmembership Create a new Usergroupmembership
EZmaxApiDefinitionFull.ObjectUsergroupmembershipApi usergroupmembershipDeleteObjectV1 DELETE /1/object/usergroupmembership/{pkiUsergroupmembershipID} Delete an existing Usergroupmembership
EZmaxApiDefinitionFull.ObjectUsergroupmembershipApi usergroupmembershipEditObjectV1 PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} Edit an existing Usergroupmembership
EZmaxApiDefinitionFull.ObjectUsergroupmembershipApi usergroupmembershipGetObjectV2 GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} Retrieve an existing Usergroupmembership
EZmaxApiDefinitionFull.ObjectUserstagedApi userstagedCreateUserV1 POST /1/object/userstaged/{pkiUserstagedID}/createUser Create a User from a Userstaged and then map it
EZmaxApiDefinitionFull.ObjectUserstagedApi userstagedDeleteObjectV1 DELETE /1/object/userstaged/{pkiUserstagedID} Delete an existing Userstaged
EZmaxApiDefinitionFull.ObjectUserstagedApi userstagedGetListV1 GET /1/object/userstaged/getList Retrieve Userstaged list
EZmaxApiDefinitionFull.ObjectUserstagedApi userstagedGetObjectV2 GET /2/object/userstaged/{pkiUserstagedID} Retrieve an existing Userstaged
EZmaxApiDefinitionFull.ObjectUserstagedApi userstagedMapV1 POST /1/object/userstaged/{pkiUserstagedID}/map Map the Userstaged to an existing user
EZmaxApiDefinitionFull.ObjectVariableexpenseApi variableexpenseCreateObjectV1 POST /1/object/variableexpense Create a new Variableexpense
EZmaxApiDefinitionFull.ObjectVariableexpenseApi variableexpenseEditObjectV1 PUT /1/object/variableexpense/{pkiVariableexpenseID} Edit an existing Variableexpense
EZmaxApiDefinitionFull.ObjectVariableexpenseApi variableexpenseGetAutocompleteV2 GET /2/object/variableexpense/getAutocomplete/{sSelector} Retrieve Variableexpenses and IDs
EZmaxApiDefinitionFull.ObjectVariableexpenseApi variableexpenseGetListV1 GET /1/object/variableexpense/getList Retrieve Variableexpense list
EZmaxApiDefinitionFull.ObjectVariableexpenseApi variableexpenseGetObjectV2 GET /2/object/variableexpense/{pkiVariableexpenseID} Retrieve an existing Variableexpense
EZmaxApiDefinitionFull.ObjectVersionhistoryApi versionhistoryGetObjectV2 GET /2/object/versionhistory/{pkiVersionhistoryID} Retrieve an existing Versionhistory
EZmaxApiDefinitionFull.ObjectWebhookApi webhookCreateObjectV1 POST /1/object/webhook Create a new Webhook
EZmaxApiDefinitionFull.ObjectWebhookApi webhookDeleteObjectV1 DELETE /1/object/webhook/{pkiWebhookID} Delete an existing Webhook
EZmaxApiDefinitionFull.ObjectWebhookApi webhookEditObjectV1 PUT /1/object/webhook/{pkiWebhookID} Edit an existing Webhook
EZmaxApiDefinitionFull.ObjectWebhookApi webhookGetHistoryV1 GET /1/object/webhook/{pkiWebhookID}/getHistory Retrieve the logs for recent Webhook calls
EZmaxApiDefinitionFull.ObjectWebhookApi webhookGetListV1 GET /1/object/webhook/getList Retrieve Webhook list
EZmaxApiDefinitionFull.ObjectWebhookApi webhookGetObjectV2 GET /2/object/webhook/{pkiWebhookID} Retrieve an existing Webhook
EZmaxApiDefinitionFull.ObjectWebhookApi webhookTestV1 POST /1/object/webhook/{pkiWebhookID}/test Test the Webhook by calling the Url
EZmaxApiDefinitionFull.ScimGroupsApi groupsCreateObjectScimV2 POST /2/scim/Groups Create a new Usergroup
EZmaxApiDefinitionFull.ScimGroupsApi groupsDeleteObjectScimV2 DELETE /2/scim/Groups/{groupId} Delete an existing Usergroup
EZmaxApiDefinitionFull.ScimGroupsApi groupsEditObjectScimV2 PUT /2/scim/Groups/{groupId} Edit an existing Usergroup
EZmaxApiDefinitionFull.ScimGroupsApi groupsGetListScimV2 GET /2/scim/Groups Retrieve Usergroup list
EZmaxApiDefinitionFull.ScimGroupsApi groupsGetObjectScimV2 GET /2/scim/Groups/{groupId} Retrieve an existing Usergroup
EZmaxApiDefinitionFull.ScimServiceProviderConfigApi serviceProviderConfigGetObjectScimV2 GET /2/scim/ServiceProviderConfig Get Service Provider Configuration
EZmaxApiDefinitionFull.ScimUsersApi usersCreateObjectScimV2 POST /2/scim/Users Create a new User
EZmaxApiDefinitionFull.ScimUsersApi usersDeleteObjectScimV2 DELETE /2/scim/Users/{userId} Delete an existing User
EZmaxApiDefinitionFull.ScimUsersApi usersEditObjectScimV2 PUT /2/scim/Users/{userId} Edit an existing User
EZmaxApiDefinitionFull.ScimUsersApi usersGetListScimV2 GET /2/scim/Users Retrieve User list
EZmaxApiDefinitionFull.ScimUsersApi usersGetObjectScimV2 GET /2/scim/Users/{userId} Retrieve an existing User

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

Authorization

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Bearer

  • Type: Bearer authentication

Presigned

  • Type: API key
  • API key parameter name: sAuthorization
  • Location: URL query string