Skip to content

The Official eZmax and eZsign PHP SDK for interacting with the REST API.

License

Notifications You must be signed in to change notification settings

eZmaxinc/eZmax-SDK-php

Repository files navigation

eZmaxApi

This API expose all the functionnalities for the eZmax and eZsign applications.

For more information, please visit https://www.ezmax.ca/en/contact.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/ezmaxinc/ezmax-sdk-php.git"
    }
  ],
  "require": {
    "ezmaxinc/ezmax-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/eZmaxApi/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new eZmaxAPI\Api\GlobalCustomerApi(
    // 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()
);
$pksCustomerCode = 'pksCustomerCode_example'; // string
$sInfrastructureproductCode = 'sInfrastructureproductCode_example'; // string | The infrastructure product Code  If undefined, \"appcluster01\" is assumed

try {
    $result = $apiInstance->globalCustomerGetEndpointV1($pksCustomerCode, $sInfrastructureproductCode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlobalCustomerApi->globalCustomerGetEndpointV1: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Class Method HTTP request Description
GlobalCustomerApi globalCustomerGetEndpointV1 GET /1/customer/{pksCustomerCode}/endpoint Get customer endpoint
GlobalEzmaxclientApi globalEzmaxclientVersionV1 GET /1/ezmaxclient/{pksEzmaxclientOs}/version Retrieve the latest version of the Ezmaxclient
GlobalEzmaxcustomerApi globalEzmaxcustomerGetConfigurationV1 GET /1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration Get ezmaxcustomer configuration
ModuleEzsignApi ezsignSuggestSignersV1 GET /1/module/ezsign/suggestSigners Suggest signers
ModuleEzsignApi ezsignSuggestTemplatesV1 GET /1/module/ezsign/suggestTemplates Suggest templates
ModuleReportApi reportGetReportFromCacheV1 GET /1/module/report/getReportFromCache/{sReportgroupCacheID} Retrieve report from cache
ModuleUserApi userCreateEzsignuserV1 POST /1/module/user/createezsignuser Create a new User of type Ezsignuser
ObjectActivesessionApi activesessionGetCurrentV1 GET /1/object/activesession/getCurrent Get Current Activesession
ObjectActivesessionApi activesessionGetListV1 GET /1/object/activesession/getList Retrieve Activesession list
ObjectApikeyApi apikeyCreateObjectV2 POST /2/object/apikey Create a new Apikey
ObjectApikeyApi apikeyEditObjectV1 PUT /1/object/apikey/{pkiApikeyID} Edit an existing Apikey
ObjectApikeyApi apikeyEditPermissionsV1 PUT /1/object/apikey/{pkiApikeyID}/editPermissions Edit multiple Permissions
ObjectApikeyApi apikeyGetCorsV1 GET /1/object/apikey/{pkiApikeyID}/getCors Retrieve an existing Apikey's cors
ObjectApikeyApi apikeyGetListV1 GET /1/object/apikey/getList Retrieve Apikey list
ObjectApikeyApi apikeyGetObjectV2 GET /2/object/apikey/{pkiApikeyID} Retrieve an existing Apikey
ObjectApikeyApi apikeyGetPermissionsV1 GET /1/object/apikey/{pkiApikeyID}/getPermissions Retrieve an existing Apikey's Permissions
ObjectApikeyApi apikeyGetSubnetsV1 GET /1/object/apikey/{pkiApikeyID}/getSubnets Retrieve an existing Apikey's subnets
ObjectApikeyApi apikeyRegenerateV1 POST /1/object/apikey/{pkiApikeyID}/regenerate Regenerate the Apikey
ObjectAttachmentApi attachmentDownloadV1 GET /1/object/attachment/{pkiAttachmentID}/download Retrieve the content
ObjectAttachmentApi attachmentGetAttachmentlogsV1 GET /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs Retrieve the Attachmentlogs
ObjectAttachmentApi attachmentGetDownloadUrlV1 GET /1/object/attachment/{pkiAttachmentID}/getDownloadUrl Retrieve a URL to download attachments.
ObjectBillingentityexternalApi billingentityexternalGetAutocompleteV2 GET /2/object/billingentityexternal/getAutocomplete/{sSelector} Retrieve Billingentityexternals and IDs
ObjectBillingentityinternalApi billingentityinternalCreateObjectV1 POST /1/object/billingentityinternal Create a new Billingentityinternal
ObjectBillingentityinternalApi billingentityinternalEditObjectV1 PUT /1/object/billingentityinternal/{pkiBillingentityinternalID} Edit an existing Billingentityinternal
ObjectBillingentityinternalApi billingentityinternalGetAutocompleteV2 GET /2/object/billingentityinternal/getAutocomplete/{sSelector} Retrieve Billingentityinternals and IDs
ObjectBillingentityinternalApi billingentityinternalGetListV1 GET /1/object/billingentityinternal/getList Retrieve Billingentityinternal list
ObjectBillingentityinternalApi billingentityinternalGetObjectV2 GET /2/object/billingentityinternal/{pkiBillingentityinternalID} Retrieve an existing Billingentityinternal
ObjectBrandingApi brandingCreateObjectV1 POST /1/object/branding Create a new Branding
ObjectBrandingApi brandingEditObjectV1 PUT /1/object/branding/{pkiBrandingID} Edit an existing Branding
ObjectBrandingApi brandingGetAutocompleteV2 GET /2/object/branding/getAutocomplete/{sSelector} Retrieve Brandings and IDs
ObjectBrandingApi brandingGetListV1 GET /1/object/branding/getList Retrieve Branding list
ObjectBrandingApi brandingGetObjectV2 GET /2/object/branding/{pkiBrandingID} Retrieve an existing Branding
ObjectBuyercontractApi buyercontractGetCommunicationListV1 GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList Retrieve Communication list
ObjectClonehistoryApi clonehistoryGetListV1 GET /1/object/clonehistory/getList Retrieve Clonehistory list
ObjectCommunicationApi communicationSendV1 POST /1/object/communication/send Send a new Communication
ObjectCompanyApi companyGetAutocompleteV2 GET /2/object/company/getAutocomplete/{sSelector} Retrieve Companys and IDs
ObjectCorsApi corsCreateObjectV1 POST /1/object/cors Create a new Cors
ObjectCorsApi corsDeleteObjectV1 DELETE /1/object/cors/{pkiCorsID} Delete an existing Cors
ObjectCorsApi corsEditObjectV1 PUT /1/object/cors/{pkiCorsID} Edit an existing Cors
ObjectCorsApi corsGetObjectV2 GET /2/object/cors/{pkiCorsID} Retrieve an existing Cors
ObjectCountryApi countryGetAutocompleteV2 GET /2/object/country/getAutocomplete/{sSelector} Retrieve Countries and IDs
ObjectCreditcardclientApi creditcardclientCreateObjectV1 POST /1/object/creditcardclient Create a new Creditcardclient
ObjectCreditcardclientApi creditcardclientDeleteObjectV1 DELETE /1/object/creditcardclient/{pkiCreditcardclientID} Delete an existing Creditcardclient
ObjectCreditcardclientApi creditcardclientEditObjectV1 PUT /1/object/creditcardclient/{pkiCreditcardclientID} Edit an existing Creditcardclient
ObjectCreditcardclientApi creditcardclientGetAutocompleteV2 GET /2/object/creditcardclient/getAutocomplete/{sSelector} Retrieve Creditcardclients and IDs
ObjectCreditcardclientApi creditcardclientGetListV1 GET /1/object/creditcardclient/getList Retrieve Creditcardclient list
ObjectCreditcardclientApi creditcardclientGetObjectV2 GET /2/object/creditcardclient/{pkiCreditcardclientID} Retrieve an existing Creditcardclient
ObjectCreditcardtypeApi creditcardtypeGetAutocompleteV2 GET /2/object/creditcardtype/getAutocomplete/{sSelector} Retrieve Creditcardtypes and IDs
ObjectDepartmentApi departmentGetAutocompleteV2 GET /2/object/department/getAutocomplete/{sSelector} Retrieve Departments and IDs
ObjectDiscussionApi discussionCreateObjectV1 POST /1/object/discussion Create a new Discussion
ObjectDiscussionApi discussionDeleteObjectV1 DELETE /1/object/discussion/{pkiDiscussionID} Delete an existing Discussion
ObjectDiscussionApi discussionGetObjectV2 GET /2/object/discussion/{pkiDiscussionID} Retrieve an existing Discussion
ObjectDiscussionApi discussionPatchObjectV1 PATCH /1/object/discussion/{pkiDiscussionID} Patch an existing Discussion
ObjectDiscussionApi discussionUpdateDiscussionreadstatusV1 POST /1/object/discussion/{pkiDiscussionID}/updateDiscussionreadstatus Update the read status of the discussion
ObjectDiscussionmembershipApi discussionmembershipCreateObjectV1 POST /1/object/discussionmembership Create a new Discussionmembership
ObjectDiscussionmembershipApi discussionmembershipDeleteObjectV1 DELETE /1/object/discussionmembership/{pkiDiscussionmembershipID} Delete an existing Discussionmembership
ObjectDiscussionmessageApi discussionmessageCreateObjectV1 POST /1/object/discussionmessage Create a new Discussionmessage
ObjectDiscussionmessageApi discussionmessageDeleteObjectV1 DELETE /1/object/discussionmessage/{pkiDiscussionmessageID} Delete an existing Discussionmessage
ObjectDiscussionmessageApi discussionmessagePatchObjectV1 PATCH /1/object/discussionmessage/{pkiDiscussionmessageID} Patch an existing Discussionmessage
ObjectElectronicfundstransferApi electronicfundstransferGetCommunicationListV1 GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList Retrieve Communication list
ObjectEmailtypeApi emailtypeGetAutocompleteV2 GET /2/object/emailtype/getAutocomplete/{sSelector} Retrieve Emailtypes and IDs
ObjectEzmaxinvoicingApi ezmaxinvoicingGetAutocompleteV2 GET /2/object/ezmaxinvoicing/getAutocomplete/{sSelector} Retrieve Ezmaxinvoicings and IDs
ObjectEzmaxinvoicingApi ezmaxinvoicingGetObjectV2 GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID} Retrieve an existing Ezmaxinvoicing
ObjectEzmaxinvoicingApi ezmaxinvoicingGetProvisionalV1 GET /1/object/ezmaxinvoicing/getProvisional Retrieve provisional Ezmaxinvoicing
ObjectEzmaxproductApi ezmaxproductGetAutocompleteV2 GET /2/object/ezmaxproduct/getAutocomplete/{sSelector} Retrieve Ezmaxproducts and IDs
ObjectEzsignbulksendApi ezsignbulksendCreateEzsignbulksendtransmissionV1 POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission Create a new Ezsignbulksendtransmission in the Ezsignbulksend
ObjectEzsignbulksendApi ezsignbulksendCreateObjectV1 POST /1/object/ezsignbulksend Create a new Ezsignbulksend
ObjectEzsignbulksendApi ezsignbulksendDeleteObjectV1 DELETE /1/object/ezsignbulksend/{pkiEzsignbulksendID} Delete an existing Ezsignbulksend
ObjectEzsignbulksendApi ezsignbulksendEditObjectV1 PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} Edit an existing Ezsignbulksend
ObjectEzsignbulksendApi ezsignbulksendGetCsvTemplateV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getCsvTemplate Retrieve an existing Ezsignbulksend's empty Csv template
ObjectEzsignbulksendApi ezsignbulksendGetEzsignbulksendtransmissionsV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignbulksendtransmissions Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions
ObjectEzsignbulksendApi ezsignbulksendGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures
ObjectEzsignbulksendApi ezsignbulksendGetFormsDataV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData Retrieve an existing Ezsignbulksend's forms data
ObjectEzsignbulksendApi ezsignbulksendGetListV1 GET /1/object/ezsignbulksend/getList Retrieve Ezsignbulksend list
ObjectEzsignbulksendApi ezsignbulksendGetObjectV2 GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} Retrieve an existing Ezsignbulksend
ObjectEzsignbulksendApi ezsignbulksendReorderV1 POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend
ObjectEzsignbulksenddocumentmappingApi ezsignbulksenddocumentmappingCreateObjectV1 POST /1/object/ezsignbulksenddocumentmapping Create a new Ezsignbulksenddocumentmapping
ObjectEzsignbulksenddocumentmappingApi ezsignbulksenddocumentmappingDeleteObjectV1 DELETE /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} Delete an existing Ezsignbulksenddocumentmapping
ObjectEzsignbulksenddocumentmappingApi ezsignbulksenddocumentmappingGetObjectV2 GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} Retrieve an existing Ezsignbulksenddocumentmapping
ObjectEzsignbulksendsignermappingApi ezsignbulksendsignermappingCreateObjectV1 POST /1/object/ezsignbulksendsignermapping Create a new Ezsignbulksendsignermapping
ObjectEzsignbulksendsignermappingApi ezsignbulksendsignermappingDeleteObjectV1 DELETE /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} Delete an existing Ezsignbulksendsignermapping
ObjectEzsignbulksendsignermappingApi ezsignbulksendsignermappingGetObjectV2 GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} Retrieve an existing Ezsignbulksendsignermapping
ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmissionGetCsvErrorsV1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getCsvErrors Retrieve an existing Ezsignbulksendtransmission's Csv containing errors
ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmissionGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures
ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmissionGetFormsDataV1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData Retrieve an existing Ezsignbulksendtransmission's forms data
ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmissionGetObjectV2 GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} Retrieve an existing Ezsignbulksendtransmission
ObjectEzsigndiscussionApi ezsigndiscussionCreateObjectV1 POST /1/object/ezsigndiscussion Create a new Ezsigndiscussion
ObjectEzsigndiscussionApi ezsigndiscussionDeleteObjectV1 DELETE /1/object/ezsigndiscussion/{pkiEzsigndiscussionID} Delete an existing Ezsigndiscussion
ObjectEzsigndiscussionApi ezsigndiscussionGetObjectV2 GET /2/object/ezsigndiscussion/{pkiEzsigndiscussionID} Retrieve an existing Ezsigndiscussion
ObjectEzsigndocumentApi ezsigndocumentApplyEzsigntemplateV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate Apply an Ezsigntemplate to the Ezsigndocument.
ObjectEzsigndocumentApi ezsigndocumentApplyEzsigntemplateV2 POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate Apply an Ezsigntemplate to the Ezsigndocument.
ObjectEzsigndocumentApi ezsigndocumentApplyEzsigntemplateglobalV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplateglobal Apply an Ezsigntemplateglobal to the Ezsigndocument.
ObjectEzsigndocumentApi ezsigndocumentCreateEzsignelementsPositionedByWordV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord Create multiple Ezsignsignatures/Ezsignformfieldgroups
ObjectEzsigndocumentApi ezsigndocumentCreateObjectV1 POST /1/object/ezsigndocument Create a new Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentCreateObjectV2 POST /2/object/ezsigndocument Create a new Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentDeclineToSignV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign Decline to sign
ObjectEzsigndocumentApi ezsigndocumentDeleteObjectV1 DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID} Delete an existing Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentEditEzsignformfieldgroupsV1 PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups Edit multiple Ezsignformfieldgroups
ObjectEzsigndocumentApi ezsigndocumentEditEzsignsignaturesV1 PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures Edit multiple Ezsignsignatures
ObjectEzsigndocumentApi ezsigndocumentEndPrematurelyV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely End prematurely
ObjectEzsigndocumentApi ezsigndocumentFlattenV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten Flatten
ObjectEzsigndocumentApi ezsigndocumentGetActionableElementsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements Retrieve actionable elements for the Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentGetAttachmentsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments Retrieve Ezsigndocument's Attachments
ObjectEzsigndocumentApi ezsigndocumentGetCompletedElementsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements Retrieve completed elements for the Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentGetDownloadUrlV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} Retrieve a URL to download documents.
ObjectEzsigndocumentApi ezsigndocumentGetEzsignannotationsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations Retrieve an existing Ezsigndocument's Ezsignannotations
ObjectEzsigndocumentApi ezsigndocumentGetEzsigndiscussionsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsigndiscussions Retrieve an existing Ezsigndocument's Ezsigndiscussions
ObjectEzsigndocumentApi ezsigndocumentGetEzsignformfieldgroupsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups Retrieve an existing Ezsigndocument's Ezsignformfieldgroups
ObjectEzsigndocumentApi ezsigndocumentGetEzsignpagesV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages Retrieve an existing Ezsigndocument's Ezsignpages
ObjectEzsigndocumentApi ezsigndocumentGetEzsignsignaturesAutomaticV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsigndocument's automatic Ezsignsignatures
ObjectEzsigndocumentApi ezsigndocumentGetEzsignsignaturesV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures Retrieve an existing Ezsigndocument's Ezsignsignatures
ObjectEzsigndocumentApi ezsigndocumentGetFormDataV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData Retrieve an existing Ezsigndocument's Form Data
ObjectEzsigndocumentApi ezsigndocumentGetObjectV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentGetObjectV2 GET /2/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentGetTemporaryProofV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof Retrieve the temporary proof
ObjectEzsigndocumentApi ezsigndocumentGetWordsPositionsV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentPatchObjectV1 PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID} Patch an existing Ezsigndocument
ObjectEzsigndocumentApi ezsigndocumentSubmitEzsignformV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform Submit the Ezsignform
ObjectEzsigndocumentApi ezsigndocumentUnsendV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend Unsend the Ezsigndocument
ObjectEzsignfolderApi ezsignfolderArchiveV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive Archive the Ezsignfolder
ObjectEzsignfolderApi ezsignfolderBatchDownloadV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload Download multiples files from an Ezsignfolder
ObjectEzsignfolderApi ezsignfolderCreateObjectV1 POST /1/object/ezsignfolder Create a new Ezsignfolder
ObjectEzsignfolderApi ezsignfolderCreateObjectV2 POST /2/object/ezsignfolder Create a new Ezsignfolder
ObjectEzsignfolderApi ezsignfolderDeleteObjectV1 DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} Delete an existing Ezsignfolder
ObjectEzsignfolderApi ezsignfolderDisposeEzsignfoldersV1 POST /1/object/ezsignfolder/disposeEzsignfolders Dispose Ezsignfolders
ObjectEzsignfolderApi ezsignfolderDisposeV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose Dispose the Ezsignfolder
ObjectEzsignfolderApi ezsignfolderEditObjectV1 PUT /1/object/ezsignfolder/{pkiEzsignfolderID} Edit an existing Ezsignfolder
ObjectEzsignfolderApi ezsignfolderEndPrematurelyV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/endPrematurely End prematurely
ObjectEzsignfolderApi ezsignfolderGetActionableElementsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements Retrieve actionable elements for the Ezsignfolder
ObjectEzsignfolderApi ezsignfolderGetAttachmentCountV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount Retrieve Attachment count
ObjectEzsignfolderApi ezsignfolderGetAttachmentsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments Retrieve Ezsignfolder's Attachments
ObjectEzsignfolderApi ezsignfolderGetCommunicationCountV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount Retrieve Communication count
ObjectEzsignfolderApi ezsignfolderGetCommunicationListV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList Retrieve Communication list
ObjectEzsignfolderApi ezsignfolderGetCommunicationrecipientsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients Retrieve Ezsignfolder's Communicationrecipient
ObjectEzsignfolderApi ezsignfolderGetCommunicationsendersV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders Retrieve Ezsignfolder's Communicationsender
ObjectEzsignfolderApi ezsignfolderGetEzsigndocumentsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments Retrieve an existing Ezsignfolder's Ezsigndocuments
ObjectEzsignfolderApi ezsignfolderGetEzsignfoldersignerassociationsV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
ObjectEzsignfolderApi ezsignfolderGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
ObjectEzsignfolderApi ezsignfolderGetFormsDataV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData Retrieve an existing Ezsignfolder's forms data
ObjectEzsignfolderApi ezsignfolderGetListV1 GET /1/object/ezsignfolder/getList Retrieve Ezsignfolder list
ObjectEzsignfolderApi ezsignfolderGetObjectV1 GET /1/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
ObjectEzsignfolderApi ezsignfolderGetObjectV2 GET /2/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
ObjectEzsignfolderApi ezsignfolderImportEzsignfoldersignerassociationsV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
ObjectEzsignfolderApi ezsignfolderImportEzsigntemplatepackageV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage Import an Ezsigntemplatepackage in the Ezsignfolder.
ObjectEzsignfolderApi ezsignfolderReorderV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder Reorder Ezsigndocuments in the Ezsignfolder
ObjectEzsignfolderApi ezsignfolderSendV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
ObjectEzsignfolderApi ezsignfolderSendV3 POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
ObjectEzsignfolderApi ezsignfolderUnsendV1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend Unsend the Ezsignfolder
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationCreateEmbeddedUrlV1 POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/createEmbeddedUrl Creates an Url to allow embedded signing
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationCreateObjectV1 POST /1/object/ezsignfoldersignerassociation Create a new Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationCreateObjectV2 POST /2/object/ezsignfoldersignerassociation Create a new Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationDeleteObjectV1 DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Delete an existing Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationEditObjectV1 PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Edit an existing Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationForceDisconnectV1 POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/forceDisconnect Disconnects the Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetInPersonLoginUrlV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getInPersonLoginUrl Retrieve a Login Url to allow In-Person signing
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetObjectV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Retrieve an existing Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationGetObjectV2 GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Retrieve an existing Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociationPatchObjectV1 PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Patch an existing Ezsignfoldersignerassociation
ObjectEzsignfoldertypeApi ezsignfoldertypeCreateObjectV2 POST /2/object/ezsignfoldertype Create a new Ezsignfoldertype
ObjectEzsignfoldertypeApi ezsignfoldertypeEditObjectV1 PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Edit an existing Ezsignfoldertype
ObjectEzsignfoldertypeApi ezsignfoldertypeEditObjectV2 PUT /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Edit an existing Ezsignfoldertype
ObjectEzsignfoldertypeApi ezsignfoldertypeGetAutocompleteV2 GET /2/object/ezsignfoldertype/getAutocomplete/{sSelector} Retrieve Ezsignfoldertypes and IDs
ObjectEzsignfoldertypeApi ezsignfoldertypeGetListV1 GET /1/object/ezsignfoldertype/getList Retrieve Ezsignfoldertype list
ObjectEzsignfoldertypeApi ezsignfoldertypeGetObjectV2 GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype
ObjectEzsignfoldertypeApi ezsignfoldertypeGetObjectV3 GET /3/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype
ObjectEzsignformfieldgroupApi ezsignformfieldgroupCreateObjectV1 POST /1/object/ezsignformfieldgroup Create a new Ezsignformfieldgroup
ObjectEzsignformfieldgroupApi ezsignformfieldgroupDeleteObjectV1 DELETE /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} Delete an existing Ezsignformfieldgroup
ObjectEzsignformfieldgroupApi ezsignformfieldgroupEditObjectV1 PUT /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} Edit an existing Ezsignformfieldgroup
ObjectEzsignformfieldgroupApi ezsignformfieldgroupGetObjectV2 GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} Retrieve an existing Ezsignformfieldgroup
ObjectEzsignpageApi ezsignpageConsultV1 POST /1/object/ezsignpage/{pkiEzsignpageID}/consult Consult an Ezsignpage
ObjectEzsignsignatureApi ezsignsignatureCreateObjectV1 POST /1/object/ezsignsignature Create a new Ezsignsignature
ObjectEzsignsignatureApi ezsignsignatureCreateObjectV2 POST /2/object/ezsignsignature Create a new Ezsignsignature
ObjectEzsignsignatureApi ezsignsignatureDeleteObjectV1 DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} Delete an existing Ezsignsignature
ObjectEzsignsignatureApi ezsignsignatureEditObjectV1 PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} Edit an existing Ezsignsignature
ObjectEzsignsignatureApi ezsignsignatureGetEzsignsignatureattachmentV1 GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment Retrieve an existing Ezsignsignature's Ezsignsignatureattachments
ObjectEzsignsignatureApi ezsignsignatureGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic Retrieve all automatic Ezsignsignatures
ObjectEzsignsignatureApi ezsignsignatureGetObjectV2 GET /2/object/ezsignsignature/{pkiEzsignsignatureID} Retrieve an existing Ezsignsignature
ObjectEzsignsignatureApi ezsignsignatureSignV1 POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign Sign the Ezsignsignature
ObjectEzsignsignergroupApi ezsignsignergroupCreateObjectV1 POST /1/object/ezsignsignergroup Create a new Ezsignsignergroup
ObjectEzsignsignergroupApi ezsignsignergroupDeleteObjectV1 DELETE /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} Delete an existing Ezsignsignergroup
ObjectEzsignsignergroupApi ezsignsignergroupEditEzsignsignergroupmembershipsV1 PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships Edit multiple Ezsignsignergroupmemberships
ObjectEzsignsignergroupApi ezsignsignergroupEditObjectV1 PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} Edit an existing Ezsignsignergroup
ObjectEzsignsignergroupApi ezsignsignergroupGetEzsignsignergroupmembershipsV1 GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships
ObjectEzsignsignergroupApi ezsignsignergroupGetObjectV2 GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID} Retrieve an existing Ezsignsignergroup
ObjectEzsignsignergroupmembershipApi ezsignsignergroupmembershipCreateObjectV1 POST /1/object/ezsignsignergroupmembership Create a new Ezsignsignergroupmembership
ObjectEzsignsignergroupmembershipApi ezsignsignergroupmembershipDeleteObjectV1 DELETE /1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} Delete an existing Ezsignsignergroupmembership
ObjectEzsignsignergroupmembershipApi ezsignsignergroupmembershipGetObjectV2 GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} Retrieve an existing Ezsignsignergroupmembership
ObjectEzsignsigningreasonApi ezsignsigningreasonCreateObjectV1 POST /1/object/ezsignsigningreason Create a new Ezsignsigningreason
ObjectEzsignsigningreasonApi ezsignsigningreasonEditObjectV1 PUT /1/object/ezsignsigningreason/{pkiEzsignsigningreasonID} Edit an existing Ezsignsigningreason
ObjectEzsignsigningreasonApi ezsignsigningreasonGetAutocompleteV2 GET /2/object/ezsignsigningreason/getAutocomplete/{sSelector} Retrieve Ezsignsigningreasons and IDs
ObjectEzsignsigningreasonApi ezsignsigningreasonGetListV1 GET /1/object/ezsignsigningreason/getList Retrieve Ezsignsigningreason list
ObjectEzsignsigningreasonApi ezsignsigningreasonGetObjectV2 GET /2/object/ezsignsigningreason/{pkiEzsignsigningreasonID} Retrieve an existing Ezsignsigningreason
ObjectEzsigntemplateApi ezsigntemplateCopyV1 POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy Copy the Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplateCreateObjectV1 POST /1/object/ezsigntemplate Create a new Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplateCreateObjectV2 POST /2/object/ezsigntemplate Create a new Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplateDeleteObjectV1 DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID} Delete an existing Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplateEditObjectV1 PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID} Edit an existing Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplateEditObjectV2 PUT /2/object/ezsigntemplate/{pkiEzsigntemplateID} Edit an existing Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplateGetAutocompleteV2 GET /2/object/ezsigntemplate/getAutocomplete/{sSelector} Retrieve Ezsigntemplates and IDs
ObjectEzsigntemplateApi ezsigntemplateGetListV1 GET /1/object/ezsigntemplate/getList Retrieve Ezsigntemplate list
ObjectEzsigntemplateApi ezsigntemplateGetObjectV1 GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} Retrieve an existing Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplateGetObjectV2 GET /2/object/ezsigntemplate/{pkiEzsigntemplateID} Retrieve an existing Ezsigntemplate
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentCreateObjectV1 POST /1/object/ezsigntemplatedocument Create a new Ezsigntemplatedocument
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups Edit multiple Ezsigntemplateformfieldgroups
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentEditEzsigntemplatesignaturesV1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures Edit multiple Ezsigntemplatesignatures
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentEditObjectV1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Edit an existing Ezsigntemplatedocument
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentFlattenV1 POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten Flatten
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplateformfieldgroups Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentGetEzsigntemplatesignaturesV1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentGetObjectV2 GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Retrieve an existing Ezsigntemplatedocument
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentGetWordsPositionsV1 POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigntemplatedocument
ObjectEzsigntemplatedocumentApi ezsigntemplatedocumentPatchObjectV1 PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Patch an existing Ezsigntemplatedocument
ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroupCreateObjectV1 POST /1/object/ezsigntemplateformfieldgroup Create a new Ezsigntemplateformfieldgroup
ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroupDeleteObjectV1 DELETE /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} Delete an existing Ezsigntemplateformfieldgroup
ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroupEditObjectV1 PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} Edit an existing Ezsigntemplateformfieldgroup
ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroupGetObjectV2 GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} Retrieve an existing Ezsigntemplateformfieldgroup
ObjectEzsigntemplateglobalApi ezsigntemplateglobalGetAutocompleteV2 GET /2/object/ezsigntemplateglobal/getAutocomplete/{sSelector} Retrieve Ezsigntemplateglobals and IDs
ObjectEzsigntemplateglobalApi ezsigntemplateglobalGetObjectV2 GET /2/object/ezsigntemplateglobal/{pkiEzsigntemplateglobalID} Retrieve an existing Ezsigntemplateglobal
ObjectEzsigntemplatepackageApi ezsigntemplatepackageCreateObjectV1 POST /1/object/ezsigntemplatepackage Create a new Ezsigntemplatepackage
ObjectEzsigntemplatepackageApi ezsigntemplatepackageDeleteObjectV1 DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Delete an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackageApi ezsigntemplatepackageEditEzsigntemplatepackagesignersV1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners Edit multiple Ezsigntemplatepackagesigners
ObjectEzsigntemplatepackageApi ezsigntemplatepackageEditObjectV1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Edit an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackageApi ezsigntemplatepackageGetAutocompleteV2 GET /2/object/ezsigntemplatepackage/getAutocomplete/{sSelector} Retrieve Ezsigntemplatepackages and IDs
ObjectEzsigntemplatepackageApi ezsigntemplatepackageGetListV1 GET /1/object/ezsigntemplatepackage/getList Retrieve Ezsigntemplatepackage list
ObjectEzsigntemplatepackageApi ezsigntemplatepackageGetObjectV2 GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Retrieve an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackagemembershipApi ezsigntemplatepackagemembershipCreateObjectV1 POST /1/object/ezsigntemplatepackagemembership Create a new Ezsigntemplatepackagemembership
ObjectEzsigntemplatepackagemembershipApi ezsigntemplatepackagemembershipDeleteObjectV1 DELETE /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} Delete an existing Ezsigntemplatepackagemembership
ObjectEzsigntemplatepackagemembershipApi ezsigntemplatepackagemembershipGetObjectV2 GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} Retrieve an existing Ezsigntemplatepackagemembership
ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesignerCreateObjectV1 POST /1/object/ezsigntemplatepackagesigner Create a new Ezsigntemplatepackagesigner
ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesignerDeleteObjectV1 DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} Delete an existing Ezsigntemplatepackagesigner
ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesignerEditObjectV1 PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} Edit an existing Ezsigntemplatepackagesigner
ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesignerGetObjectV2 GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} Retrieve an existing Ezsigntemplatepackagesigner
ObjectEzsigntemplatepackagesignermembershipApi ezsigntemplatepackagesignermembershipCreateObjectV1 POST /1/object/ezsigntemplatepackagesignermembership Create a new Ezsigntemplatepackagesignermembership
ObjectEzsigntemplatepackagesignermembershipApi ezsigntemplatepackagesignermembershipDeleteObjectV1 DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} Delete an existing Ezsigntemplatepackagesignermembership
ObjectEzsigntemplatepackagesignermembershipApi ezsigntemplatepackagesignermembershipGetObjectV2 GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} Retrieve an existing Ezsigntemplatepackagesignermembership
ObjectEzsigntemplatesignatureApi ezsigntemplatesignatureCreateObjectV1 POST /1/object/ezsigntemplatesignature Create a new Ezsigntemplatesignature
ObjectEzsigntemplatesignatureApi ezsigntemplatesignatureDeleteObjectV1 DELETE /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Delete an existing Ezsigntemplatesignature
ObjectEzsigntemplatesignatureApi ezsigntemplatesignatureEditObjectV1 PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Edit an existing Ezsigntemplatesignature
ObjectEzsigntemplatesignatureApi ezsigntemplatesignatureGetObjectV2 GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Retrieve an existing Ezsigntemplatesignature
ObjectEzsigntemplatesignerApi ezsigntemplatesignerCreateObjectV1 POST /1/object/ezsigntemplatesigner Create a new Ezsigntemplatesigner
ObjectEzsigntemplatesignerApi ezsigntemplatesignerDeleteObjectV1 DELETE /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Delete an existing Ezsigntemplatesigner
ObjectEzsigntemplatesignerApi ezsigntemplatesignerEditObjectV1 PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Edit an existing Ezsigntemplatesigner
ObjectEzsigntemplatesignerApi ezsigntemplatesignerGetObjectV2 GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Retrieve an existing Ezsigntemplatesigner
ObjectEzsigntsarequirementApi ezsigntsarequirementGetAutocompleteV2 GET /2/object/ezsigntsarequirement/getAutocomplete/{sSelector} Retrieve Ezsigntsarequirements and IDs
ObjectFontApi fontGetAutocompleteV2 GET /2/object/font/getAutocomplete/{sSelector} Retrieve Fonts and IDs
ObjectFranchisebrokerApi franchisebrokerGetAutocompleteV2 GET /2/object/franchisebroker/getAutocomplete/{sSelector} Retrieve Franchisebrokers and IDs
ObjectFranchiseofficeApi franchiseofficeGetAutocompleteV2 GET /2/object/franchiseoffice/getAutocomplete/{sSelector} Retrieve Franchiseoffices and IDs
ObjectFranchisereferalincomeApi franchisereferalincomeCreateObjectV2 POST /2/object/franchisereferalincome Create a new Franchisereferalincome
ObjectInscriptionApi inscriptionGetAttachmentsV1 GET /1/object/inscription/{pkiInscriptionID}/getAttachments Retrieve Inscription's Attachments
ObjectInscriptionApi inscriptionGetCommunicationListV1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList Retrieve Communication list
ObjectInscriptionApi inscriptionGetCommunicationsendersV1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationsenders Retrieve Inscription's Communicationsender
ObjectInscriptionnotauthenticatedApi inscriptionnotauthenticatedGetCommunicationListV1 GET /1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList Retrieve Communication list
ObjectInscriptiontempApi inscriptiontempGetCommunicationListV1 GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList Retrieve Communication list
ObjectInvoiceApi invoiceGetAttachmentsV1 GET /1/object/invoice/{pkiInvoiceID}/getAttachments Retrieve Invoice's Attachments
ObjectInvoiceApi invoiceGetCommunicationListV1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList Retrieve Communication list
ObjectLanguageApi languageGetAutocompleteV2 GET /2/object/language/getAutocomplete/{sSelector} Retrieve Languages and IDs
ObjectModuleApi moduleGetAutocompleteV2 GET /2/object/module/getAutocomplete/{sSelector} Retrieve Modules and IDs
ObjectModulegroupApi modulegroupGetAllV1 GET /1/object/modulegroup/getAll/{eContext} Retrieve all Modulegroups
ObjectNotificationsectionApi notificationsectionGetNotificationtestsV1 GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests Retrieve an existing Notificationsection's Notificationtests
ObjectNotificationtestApi notificationtestGetElementsV1 GET /1/object/notificationtest/{pkiNotificationtestID}/getElements Retrieve an existing Notificationtest's Elements
ObjectOtherincomeApi otherincomeGetCommunicationListV1 GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList Retrieve Communication list
ObjectPaymenttermApi paymenttermCreateObjectV1 POST /1/object/paymentterm Create a new Paymentterm
ObjectPaymenttermApi paymenttermEditObjectV1 PUT /1/object/paymentterm/{pkiPaymenttermID} Edit an existing Paymentterm
ObjectPaymenttermApi paymenttermGetAutocompleteV2 GET /2/object/paymentterm/getAutocomplete/{sSelector} Retrieve Paymentterms and IDs
ObjectPaymenttermApi paymenttermGetListV1 GET /1/object/paymentterm/getList Retrieve Paymentterm list
ObjectPaymenttermApi paymenttermGetObjectV2 GET /2/object/paymentterm/{pkiPaymenttermID} Retrieve an existing Paymentterm
ObjectPeriodApi periodGetAutocompleteV2 GET /2/object/period/getAutocomplete/{sSelector} Retrieve Periods and IDs
ObjectPermissionApi permissionCreateObjectV1 POST /1/object/permission Create a new Permission
ObjectPermissionApi permissionDeleteObjectV1 DELETE /1/object/permission/{pkiPermissionID} Delete an existing Permission
ObjectPermissionApi permissionEditObjectV1 PUT /1/object/permission/{pkiPermissionID} Edit an existing Permission
ObjectPermissionApi permissionGetObjectV2 GET /2/object/permission/{pkiPermissionID} Retrieve an existing Permission
ObjectPhonetypeApi phonetypeGetAutocompleteV2 GET /2/object/phonetype/getAutocomplete/{sSelector} Retrieve Phonetypes and IDs
ObjectProvinceApi provinceGetAutocompleteV2 GET /2/object/province/getAutocomplete/{sSelector} Retrieve Provinces and IDs
ObjectRejectedoffertopurchaseApi rejectedoffertopurchaseGetCommunicationListV1 GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList Retrieve Communication list
ObjectSecretquestionApi secretquestionGetAutocompleteV2 GET /2/object/secretquestion/getAutocomplete/{sSelector} Retrieve Secretquestions and IDs
ObjectSessionhistoryApi sessionhistoryGetListV1 GET /1/object/sessionhistory/getList Retrieve Sessionhistory list
ObjectSignatureApi signatureCreateObjectV1 POST /1/object/signature Create a new Signature
ObjectSignatureApi signatureDeleteObjectV1 DELETE /1/object/signature/{pkiSignatureID} Delete an existing Signature
ObjectSignatureApi signatureEditObjectV1 PUT /1/object/signature/{pkiSignatureID} Edit an existing Signature
ObjectSignatureApi signatureGetObjectV2 GET /2/object/signature/{pkiSignatureID} Retrieve an existing Signature
ObjectSubnetApi subnetCreateObjectV1 POST /1/object/subnet Create a new Subnet
ObjectSubnetApi subnetDeleteObjectV1 DELETE /1/object/subnet/{pkiSubnetID} Delete an existing Subnet
ObjectSubnetApi subnetEditObjectV1 PUT /1/object/subnet/{pkiSubnetID} Edit an existing Subnet
ObjectSubnetApi subnetGetObjectV2 GET /2/object/subnet/{pkiSubnetID} Retrieve an existing Subnet
ObjectSystemconfigurationApi systemconfigurationEditObjectV1 PUT /1/object/systemconfiguration/{pkiSystemconfigurationID} Edit an existing Systemconfiguration
ObjectSystemconfigurationApi systemconfigurationGetObjectV2 GET /2/object/systemconfiguration/{pkiSystemconfigurationID} Retrieve an existing Systemconfiguration
ObjectTaxassignmentApi taxassignmentGetAutocompleteV2 GET /2/object/taxassignment/getAutocomplete/{sSelector} Retrieve Taxassignments and IDs
ObjectTimezoneApi timezoneGetAutocompleteV2 GET /2/object/timezone/getAutocomplete/{sSelector} Retrieve Timezones and IDs
ObjectUserApi userCreateObjectV1 POST /1/object/user Create a new User
ObjectUserApi userCreateObjectV2 POST /2/object/user Create a new User
ObjectUserApi userEditObjectV1 PUT /1/object/user/{pkiUserID} Edit an existing User
ObjectUserApi userEditPermissionsV1 PUT /1/object/user/{pkiUserID}/editPermissions Edit multiple Permissions
ObjectUserApi userGetApikeysV1 GET /1/object/user/{pkiUserID}/getApikeys Retrieve an existing User's Apikeys
ObjectUserApi userGetAutocompleteV2 GET /2/object/user/getAutocomplete/{sSelector} Retrieve Users and IDs
ObjectUserApi userGetEffectivePermissionsV1 GET /1/object/user/{pkiUserID}/getEffectivePermissions Retrieve an existing User's Effective Permissions
ObjectUserApi userGetListV1 GET /1/object/user/getList Retrieve User list
ObjectUserApi userGetObjectV2 GET /2/object/user/{pkiUserID} Retrieve an existing User
ObjectUserApi userGetPermissionsV1 GET /1/object/user/{pkiUserID}/getPermissions Retrieve an existing User's Permissions
ObjectUserApi userGetSubnetsV1 GET /1/object/user/{pkiUserID}/getSubnets Retrieve an existing User's Subnets
ObjectUserApi userGetUsergroupexternalsV1 GET /1/object/user/{pkiUserID}/getUsergroupexternals Get User's Usergroupexternals
ObjectUserApi userGetUsergroupsV1 GET /1/object/user/{pkiUserID}/getUsergroups Get User's Usergroups
ObjectUserApi userSendPasswordResetV1 POST /1/object/user/{pkiUserID}/sendPasswordReset Send password reset
ObjectUsergroupApi usergroupCreateObjectV1 POST /1/object/usergroup Create a new Usergroup
ObjectUsergroupApi usergroupEditObjectV1 PUT /1/object/usergroup/{pkiUsergroupID} Edit an existing Usergroup
ObjectUsergroupApi usergroupEditPermissionsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions Edit multiple Permissions
ObjectUsergroupApi usergroupEditUsergroupdelegationsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations Edit multiple Usergroupdelegations
ObjectUsergroupApi usergroupEditUsergroupmembershipsV1 PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships Edit multiple Usergroupmemberships
ObjectUsergroupApi usergroupGetAutocompleteV2 GET /2/object/usergroup/getAutocomplete/{sSelector} Retrieve Usergroups and IDs
ObjectUsergroupApi usergroupGetListV1 GET /1/object/usergroup/getList Retrieve Usergroup list
ObjectUsergroupApi usergroupGetObjectV2 GET /2/object/usergroup/{pkiUsergroupID} Retrieve an existing Usergroup
ObjectUsergroupApi usergroupGetPermissionsV1 GET /1/object/usergroup/{pkiUsergroupID}/getPermissions Retrieve an existing Usergroup's Permissions
ObjectUsergroupApi usergroupGetUsergroupdelegationsV1 GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations Retrieve an existing Usergroup's Usergroupdelegations
ObjectUsergroupApi usergroupGetUsergroupmembershipsV1 GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships Retrieve an existing Usergroup's Usergroupmemberships
ObjectUsergroupdelegationApi usergroupdelegationCreateObjectV1 POST /1/object/usergroupdelegation Create a new Usergroupdelegation
ObjectUsergroupdelegationApi usergroupdelegationDeleteObjectV1 DELETE /1/object/usergroupdelegation/{pkiUsergroupdelegationID} Delete an existing Usergroupdelegation
ObjectUsergroupdelegationApi usergroupdelegationEditObjectV1 PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID} Edit an existing Usergroupdelegation
ObjectUsergroupdelegationApi usergroupdelegationGetObjectV2 GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID} Retrieve an existing Usergroupdelegation
ObjectUsergroupexternalApi usergroupexternalCreateObjectV1 POST /1/object/usergroupexternal Create a new Usergroupexternal
ObjectUsergroupexternalApi usergroupexternalDeleteObjectV1 DELETE /1/object/usergroupexternal/{pkiUsergroupexternalID} Delete an existing Usergroupexternal
ObjectUsergroupexternalApi usergroupexternalEditObjectV1 PUT /1/object/usergroupexternal/{pkiUsergroupexternalID} Edit an existing Usergroupexternal
ObjectUsergroupexternalApi usergroupexternalGetAutocompleteV2 GET /2/object/usergroupexternal/getAutocomplete/{sSelector} Retrieve Usergroupexternals and IDs
ObjectUsergroupexternalApi usergroupexternalGetListV1 GET /1/object/usergroupexternal/getList Retrieve Usergroupexternal list
ObjectUsergroupexternalApi usergroupexternalGetObjectV2 GET /2/object/usergroupexternal/{pkiUsergroupexternalID} Retrieve an existing Usergroupexternal
ObjectUsergroupexternalApi usergroupexternalGetUsergroupexternalmembershipsV1 GET /1/object/usergroupexternal/{pkiUsergroupexternalID}/getUsergroupexternalmemberships Retrieve an existing Usergroupexternal's Usergroupexternalmemberships
ObjectUsergroupexternalApi usergroupexternalGetUsergroupsV1 GET /1/object/usergroupexternal/{pkiUsergroupexternalID}/getUsergroups Get Usergroupexternal's Usergroups
ObjectUsergroupmembershipApi usergroupmembershipCreateObjectV1 POST /1/object/usergroupmembership Create a new Usergroupmembership
ObjectUsergroupmembershipApi usergroupmembershipDeleteObjectV1 DELETE /1/object/usergroupmembership/{pkiUsergroupmembershipID} Delete an existing Usergroupmembership
ObjectUsergroupmembershipApi usergroupmembershipEditObjectV1 PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} Edit an existing Usergroupmembership
ObjectUsergroupmembershipApi usergroupmembershipGetObjectV2 GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} Retrieve an existing Usergroupmembership
ObjectUserlogintypeApi userlogintypeGetAutocompleteV2 GET /2/object/userlogintype/getAutocomplete/{sSelector} Retrieve Userlogintypes and IDs
ObjectUserstagedApi userstagedCreateUserV1 POST /1/object/userstaged/{pkiUserstagedID}/createUser Create a User from a Userstaged and then map it
ObjectUserstagedApi userstagedDeleteObjectV1 DELETE /1/object/userstaged/{pkiUserstagedID} Delete an existing Userstaged
ObjectUserstagedApi userstagedGetListV1 GET /1/object/userstaged/getList Retrieve Userstaged list
ObjectUserstagedApi userstagedGetObjectV2 GET /2/object/userstaged/{pkiUserstagedID} Retrieve an existing Userstaged
ObjectUserstagedApi userstagedMapV1 POST /1/object/userstaged/{pkiUserstagedID}/map Map the Userstaged to an existing user
ObjectVariableexpenseApi variableexpenseCreateObjectV1 POST /1/object/variableexpense Create a new Variableexpense
ObjectVariableexpenseApi variableexpenseEditObjectV1 PUT /1/object/variableexpense/{pkiVariableexpenseID} Edit an existing Variableexpense
ObjectVariableexpenseApi variableexpenseGetAutocompleteV2 GET /2/object/variableexpense/getAutocomplete/{sSelector} Retrieve Variableexpenses and IDs
ObjectVariableexpenseApi variableexpenseGetListV1 GET /1/object/variableexpense/getList Retrieve Variableexpense list
ObjectVariableexpenseApi variableexpenseGetObjectV2 GET /2/object/variableexpense/{pkiVariableexpenseID} Retrieve an existing Variableexpense
ObjectVersionhistoryApi versionhistoryGetObjectV2 GET /2/object/versionhistory/{pkiVersionhistoryID} Retrieve an existing Versionhistory
ObjectWebhookApi webhookCreateObjectV2 POST /2/object/webhook Create a new Webhook
ObjectWebhookApi webhookDeleteObjectV1 DELETE /1/object/webhook/{pkiWebhookID} Delete an existing Webhook
ObjectWebhookApi webhookEditObjectV1 PUT /1/object/webhook/{pkiWebhookID} Edit an existing Webhook
ObjectWebhookApi webhookGetHistoryV1 GET /1/object/webhook/{pkiWebhookID}/getHistory Retrieve the logs for recent Webhook calls
ObjectWebhookApi webhookGetListV1 GET /1/object/webhook/getList Retrieve Webhook list
ObjectWebhookApi webhookGetObjectV2 GET /2/object/webhook/{pkiWebhookID} Retrieve an existing Webhook
ObjectWebhookApi webhookRegenerateApikeyV1 POST /1/object/webhook/{pkiWebhookID}/regenerateApikey Regenerate the Apikey
ObjectWebhookApi webhookTestV1 POST /1/object/webhook/{pkiWebhookID}/test Test the Webhook by calling the Url
ScimGroupsApi groupsCreateObjectScimV2 POST /2/scim/Groups Create a new Usergroup
ScimGroupsApi groupsDeleteObjectScimV2 DELETE /2/scim/Groups/{groupId} Delete an existing Usergroup
ScimGroupsApi groupsEditObjectScimV2 PUT /2/scim/Groups/{groupId} Edit an existing Usergroup
ScimGroupsApi groupsGetListScimV2 GET /2/scim/Groups Retrieve Usergroup list
ScimGroupsApi groupsGetObjectScimV2 GET /2/scim/Groups/{groupId} Retrieve an existing Usergroup
ScimServiceProviderConfigApi serviceProviderConfigGetObjectScimV2 GET /2/scim/ServiceProviderConfig Get Service Provider Configuration
ScimUsersApi usersCreateObjectScimV2 POST /2/scim/Users Create a new User
ScimUsersApi usersDeleteObjectScimV2 DELETE /2/scim/Users/{userId} Delete an existing User
ScimUsersApi usersEditObjectScimV2 PUT /2/scim/Users/{userId} Edit an existing User
ScimUsersApi usersGetListScimV2 GET /2/scim/Users Retrieve User list
ScimUsersApi usersGetObjectScimV2 GET /2/scim/Users/{userId} Retrieve an existing User

Models

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

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support-api@ezmax.ca

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.2.0
    • Package version: 1.2.0
    • Generator version: 7.4.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen