Skip to content

Latest commit

 

History

History
1793 lines (1749 loc) · 200 KB

README.md

File metadata and controls

1793 lines (1749 loc) · 200 KB
Raw

eZmaxApi

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

This Python 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.PythonClientCodegen For more information, please visit https://www.ezmax.ca/en/contact

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/ezmaxinc/ezmax-sdk-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ezmaxinc/ezmax-sdk-python.git)

Then import the package:

import eZmaxApi

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import eZmaxApi

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import eZmaxApi
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)



# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.GlobalCustomerApi(api_client)
    pks_customer_code = 'pks_customer_code_example' # str | 
    s_infrastructureproduct_code = 's_infrastructureproduct_code_example' # str | The infrastructure product Code  If undefined, \"appcluster01\" is assumed (optional)

    try:
        # Get customer endpoint
        api_response = api_instance.global_customer_get_endpoint_v1(pks_customer_code, s_infrastructureproduct_code=s_infrastructureproduct_code)
        print("The response of GlobalCustomerApi->global_customer_get_endpoint_v1:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling GlobalCustomerApi->global_customer_get_endpoint_v1: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
GlobalCustomerApi global_customer_get_endpoint_v1 GET /1/customer/{pksCustomerCode}/endpoint Get customer endpoint
GlobalEzmaxclientApi global_ezmaxclient_version_v1 GET /1/ezmaxclient/{pksEzmaxclientOs}/version Retrieve the latest version of the Ezmaxclient
GlobalEzmaxcustomerApi global_ezmaxcustomer_get_configuration_v1 GET /1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration Get ezmaxcustomer configuration
ModuleEzsignApi ezsign_suggest_signers_v1 GET /1/module/ezsign/suggestSigners Suggest signers
ModuleEzsignApi ezsign_suggest_templates_v1 GET /1/module/ezsign/suggestTemplates Suggest templates
ModuleReportApi report_get_report_from_cache_v1 GET /1/module/report/getReportFromCache/{sReportgroupCacheID} Retrieve report from cache
ModuleUserApi user_create_ezsignuser_v1 POST /1/module/user/createezsignuser Create a new User of type Ezsignuser
ObjectActivesessionApi activesession_get_current_v1 GET /1/object/activesession/getCurrent Get Current Activesession
ObjectActivesessionApi activesession_get_list_v1 GET /1/object/activesession/getList Retrieve Activesession list
ObjectApikeyApi apikey_create_object_v2 POST /2/object/apikey Create a new Apikey
ObjectApikeyApi apikey_edit_object_v1 PUT /1/object/apikey/{pkiApikeyID} Edit an existing Apikey
ObjectApikeyApi apikey_edit_permissions_v1 PUT /1/object/apikey/{pkiApikeyID}/editPermissions Edit multiple Permissions
ObjectApikeyApi apikey_get_cors_v1 GET /1/object/apikey/{pkiApikeyID}/getCors Retrieve an existing Apikey's cors
ObjectApikeyApi apikey_get_list_v1 GET /1/object/apikey/getList Retrieve Apikey list
ObjectApikeyApi apikey_get_object_v2 GET /2/object/apikey/{pkiApikeyID} Retrieve an existing Apikey
ObjectApikeyApi apikey_get_permissions_v1 GET /1/object/apikey/{pkiApikeyID}/getPermissions Retrieve an existing Apikey's Permissions
ObjectApikeyApi apikey_get_subnets_v1 GET /1/object/apikey/{pkiApikeyID}/getSubnets Retrieve an existing Apikey's subnets
ObjectApikeyApi apikey_regenerate_v1 POST /1/object/apikey/{pkiApikeyID}/regenerate Regenerate the Apikey
ObjectAttachmentApi attachment_download_v1 GET /1/object/attachment/{pkiAttachmentID}/download Retrieve the content
ObjectAttachmentApi attachment_get_attachmentlogs_v1 GET /1/object/attachment/{pkiAttachmentID}/getAttachmentlogs Retrieve the Attachmentlogs
ObjectAttachmentApi attachment_get_download_url_v1 GET /1/object/attachment/{pkiAttachmentID}/getDownloadUrl Retrieve a URL to download attachments.
ObjectBillingentityexternalApi billingentityexternal_get_autocomplete_v2 GET /2/object/billingentityexternal/getAutocomplete/{sSelector} Retrieve Billingentityexternals and IDs
ObjectBillingentityinternalApi billingentityinternal_create_object_v1 POST /1/object/billingentityinternal Create a new Billingentityinternal
ObjectBillingentityinternalApi billingentityinternal_edit_object_v1 PUT /1/object/billingentityinternal/{pkiBillingentityinternalID} Edit an existing Billingentityinternal
ObjectBillingentityinternalApi billingentityinternal_get_autocomplete_v2 GET /2/object/billingentityinternal/getAutocomplete/{sSelector} Retrieve Billingentityinternals and IDs
ObjectBillingentityinternalApi billingentityinternal_get_list_v1 GET /1/object/billingentityinternal/getList Retrieve Billingentityinternal list
ObjectBillingentityinternalApi billingentityinternal_get_object_v2 GET /2/object/billingentityinternal/{pkiBillingentityinternalID} Retrieve an existing Billingentityinternal
ObjectBrandingApi branding_create_object_v1 POST /1/object/branding Create a new Branding
ObjectBrandingApi branding_edit_object_v1 PUT /1/object/branding/{pkiBrandingID} Edit an existing Branding
ObjectBrandingApi branding_get_autocomplete_v2 GET /2/object/branding/getAutocomplete/{sSelector} Retrieve Brandings and IDs
ObjectBrandingApi branding_get_list_v1 GET /1/object/branding/getList Retrieve Branding list
ObjectBrandingApi branding_get_object_v2 GET /2/object/branding/{pkiBrandingID} Retrieve an existing Branding
ObjectBuyercontractApi buyercontract_get_communication_list_v1 GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList Retrieve Communication list
ObjectClonehistoryApi clonehistory_get_list_v1 GET /1/object/clonehistory/getList Retrieve Clonehistory list
ObjectCommunicationApi communication_send_v1 POST /1/object/communication/send Send a new Communication
ObjectCompanyApi company_get_autocomplete_v2 GET /2/object/company/getAutocomplete/{sSelector} Retrieve Companys and IDs
ObjectCorsApi cors_create_object_v1 POST /1/object/cors Create a new Cors
ObjectCorsApi cors_delete_object_v1 DELETE /1/object/cors/{pkiCorsID} Delete an existing Cors
ObjectCorsApi cors_edit_object_v1 PUT /1/object/cors/{pkiCorsID} Edit an existing Cors
ObjectCorsApi cors_get_object_v2 GET /2/object/cors/{pkiCorsID} Retrieve an existing Cors
ObjectCountryApi country_get_autocomplete_v2 GET /2/object/country/getAutocomplete/{sSelector} Retrieve Countries and IDs
ObjectCreditcardclientApi creditcardclient_create_object_v1 POST /1/object/creditcardclient Create a new Creditcardclient
ObjectCreditcardclientApi creditcardclient_delete_object_v1 DELETE /1/object/creditcardclient/{pkiCreditcardclientID} Delete an existing Creditcardclient
ObjectCreditcardclientApi creditcardclient_edit_object_v1 PUT /1/object/creditcardclient/{pkiCreditcardclientID} Edit an existing Creditcardclient
ObjectCreditcardclientApi creditcardclient_get_autocomplete_v2 GET /2/object/creditcardclient/getAutocomplete/{sSelector} Retrieve Creditcardclients and IDs
ObjectCreditcardclientApi creditcardclient_get_list_v1 GET /1/object/creditcardclient/getList Retrieve Creditcardclient list
ObjectCreditcardclientApi creditcardclient_get_object_v2 GET /2/object/creditcardclient/{pkiCreditcardclientID} Retrieve an existing Creditcardclient
ObjectCreditcardtypeApi creditcardtype_get_autocomplete_v2 GET /2/object/creditcardtype/getAutocomplete/{sSelector} Retrieve Creditcardtypes and IDs
ObjectDepartmentApi department_get_autocomplete_v2 GET /2/object/department/getAutocomplete/{sSelector} Retrieve Departments and IDs
ObjectDiscussionApi discussion_create_object_v1 POST /1/object/discussion Create a new Discussion
ObjectDiscussionApi discussion_delete_object_v1 DELETE /1/object/discussion/{pkiDiscussionID} Delete an existing Discussion
ObjectDiscussionApi discussion_get_object_v2 GET /2/object/discussion/{pkiDiscussionID} Retrieve an existing Discussion
ObjectDiscussionApi discussion_patch_object_v1 PATCH /1/object/discussion/{pkiDiscussionID} Patch an existing Discussion
ObjectDiscussionApi discussion_update_discussionreadstatus_v1 POST /1/object/discussion/{pkiDiscussionID}/updateDiscussionreadstatus Update the read status of the discussion
ObjectDiscussionmembershipApi discussionmembership_create_object_v1 POST /1/object/discussionmembership Create a new Discussionmembership
ObjectDiscussionmembershipApi discussionmembership_delete_object_v1 DELETE /1/object/discussionmembership/{pkiDiscussionmembershipID} Delete an existing Discussionmembership
ObjectDiscussionmessageApi discussionmessage_create_object_v1 POST /1/object/discussionmessage Create a new Discussionmessage
ObjectDiscussionmessageApi discussionmessage_delete_object_v1 DELETE /1/object/discussionmessage/{pkiDiscussionmessageID} Delete an existing Discussionmessage
ObjectDiscussionmessageApi discussionmessage_patch_object_v1 PATCH /1/object/discussionmessage/{pkiDiscussionmessageID} Patch an existing Discussionmessage
ObjectElectronicfundstransferApi electronicfundstransfer_get_communication_list_v1 GET /1/object/electronicfundstransfer/{pkiElectronicfundstransferID}/getCommunicationList Retrieve Communication list
ObjectEmailtypeApi emailtype_get_autocomplete_v2 GET /2/object/emailtype/getAutocomplete/{sSelector} Retrieve Emailtypes and IDs
ObjectEzmaxinvoicingApi ezmaxinvoicing_get_autocomplete_v2 GET /2/object/ezmaxinvoicing/getAutocomplete/{sSelector} Retrieve Ezmaxinvoicings and IDs
ObjectEzmaxinvoicingApi ezmaxinvoicing_get_object_v2 GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID} Retrieve an existing Ezmaxinvoicing
ObjectEzmaxinvoicingApi ezmaxinvoicing_get_provisional_v1 GET /1/object/ezmaxinvoicing/getProvisional Retrieve provisional Ezmaxinvoicing
ObjectEzmaxproductApi ezmaxproduct_get_autocomplete_v2 GET /2/object/ezmaxproduct/getAutocomplete/{sSelector} Retrieve Ezmaxproducts and IDs
ObjectEzsignbulksendApi ezsignbulksend_create_ezsignbulksendtransmission_v1 POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission Create a new Ezsignbulksendtransmission in the Ezsignbulksend
ObjectEzsignbulksendApi ezsignbulksend_create_object_v1 POST /1/object/ezsignbulksend Create a new Ezsignbulksend
ObjectEzsignbulksendApi ezsignbulksend_delete_object_v1 DELETE /1/object/ezsignbulksend/{pkiEzsignbulksendID} Delete an existing Ezsignbulksend
ObjectEzsignbulksendApi ezsignbulksend_edit_object_v1 PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} Edit an existing Ezsignbulksend
ObjectEzsignbulksendApi ezsignbulksend_get_csv_template_v1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getCsvTemplate Retrieve an existing Ezsignbulksend's empty Csv template
ObjectEzsignbulksendApi ezsignbulksend_get_ezsignbulksendtransmissions_v1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignbulksendtransmissions Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions
ObjectEzsignbulksendApi ezsignbulksend_get_ezsignsignatures_automatic_v1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures
ObjectEzsignbulksendApi ezsignbulksend_get_forms_data_v1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData Retrieve an existing Ezsignbulksend's forms data
ObjectEzsignbulksendApi ezsignbulksend_get_list_v1 GET /1/object/ezsignbulksend/getList Retrieve Ezsignbulksend list
ObjectEzsignbulksendApi ezsignbulksend_get_object_v2 GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} Retrieve an existing Ezsignbulksend
ObjectEzsignbulksendApi ezsignbulksend_reorder_v1 POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend
ObjectEzsignbulksenddocumentmappingApi ezsignbulksenddocumentmapping_create_object_v1 POST /1/object/ezsignbulksenddocumentmapping Create a new Ezsignbulksenddocumentmapping
ObjectEzsignbulksenddocumentmappingApi ezsignbulksenddocumentmapping_delete_object_v1 DELETE /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} Delete an existing Ezsignbulksenddocumentmapping
ObjectEzsignbulksenddocumentmappingApi ezsignbulksenddocumentmapping_get_object_v2 GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID} Retrieve an existing Ezsignbulksenddocumentmapping
ObjectEzsignbulksendsignermappingApi ezsignbulksendsignermapping_create_object_v1 POST /1/object/ezsignbulksendsignermapping Create a new Ezsignbulksendsignermapping
ObjectEzsignbulksendsignermappingApi ezsignbulksendsignermapping_delete_object_v1 DELETE /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} Delete an existing Ezsignbulksendsignermapping
ObjectEzsignbulksendsignermappingApi ezsignbulksendsignermapping_get_object_v2 GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID} Retrieve an existing Ezsignbulksendsignermapping
ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmission_get_csv_errors_v1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getCsvErrors Retrieve an existing Ezsignbulksendtransmission's Csv containing errors
ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures
ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmission_get_forms_data_v1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData Retrieve an existing Ezsignbulksendtransmission's forms data
ObjectEzsignbulksendtransmissionApi ezsignbulksendtransmission_get_object_v2 GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} Retrieve an existing Ezsignbulksendtransmission
ObjectEzsigndiscussionApi ezsigndiscussion_create_object_v1 POST /1/object/ezsigndiscussion Create a new Ezsigndiscussion
ObjectEzsigndiscussionApi ezsigndiscussion_delete_object_v1 DELETE /1/object/ezsigndiscussion/{pkiEzsigndiscussionID} Delete an existing Ezsigndiscussion
ObjectEzsigndiscussionApi ezsigndiscussion_get_object_v2 GET /2/object/ezsigndiscussion/{pkiEzsigndiscussionID} Retrieve an existing Ezsigndiscussion
ObjectEzsigndocumentApi ezsigndocument_apply_ezsigntemplate_v1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate Apply an Ezsigntemplate to the Ezsigndocument.
ObjectEzsigndocumentApi ezsigndocument_apply_ezsigntemplate_v2 POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate Apply an Ezsigntemplate to the Ezsigndocument.
ObjectEzsigndocumentApi ezsigndocument_apply_ezsigntemplateglobal_v1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplateglobal Apply an Ezsigntemplateglobal to the Ezsigndocument.
ObjectEzsigndocumentApi ezsigndocument_create_ezsignelements_positioned_by_word_v1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord Create multiple Ezsignsignatures/Ezsignformfieldgroups
ObjectEzsigndocumentApi ezsigndocument_create_object_v1 POST /1/object/ezsigndocument Create a new Ezsigndocument
ObjectEzsigndocumentApi ezsigndocument_create_object_v2 POST /2/object/ezsigndocument Create a new Ezsigndocument
ObjectEzsigndocumentApi ezsigndocument_decline_to_sign_v1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign Decline to sign
ObjectEzsigndocumentApi ezsigndocument_delete_object_v1 DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID} Delete an existing Ezsigndocument
ObjectEzsigndocumentApi ezsigndocument_edit_ezsignformfieldgroups_v1 PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups Edit multiple Ezsignformfieldgroups
ObjectEzsigndocumentApi ezsigndocument_edit_ezsignsignatures_v1 PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures Edit multiple Ezsignsignatures
ObjectEzsigndocumentApi ezsigndocument_end_prematurely_v1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely End prematurely
ObjectEzsigndocumentApi ezsigndocument_flatten_v1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten Flatten
ObjectEzsigndocumentApi ezsigndocument_get_actionable_elements_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements Retrieve actionable elements for the Ezsigndocument
ObjectEzsigndocumentApi ezsigndocument_get_attachments_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments Retrieve Ezsigndocument's Attachments
ObjectEzsigndocumentApi ezsigndocument_get_completed_elements_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements Retrieve completed elements for the Ezsigndocument
ObjectEzsigndocumentApi ezsigndocument_get_download_url_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} Retrieve a URL to download documents.
ObjectEzsigndocumentApi ezsigndocument_get_ezsignannotations_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations Retrieve an existing Ezsigndocument's Ezsignannotations
ObjectEzsigndocumentApi ezsigndocument_get_ezsigndiscussions_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsigndiscussions Retrieve an existing Ezsigndocument's Ezsigndiscussions
ObjectEzsigndocumentApi ezsigndocument_get_ezsignformfieldgroups_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups Retrieve an existing Ezsigndocument's Ezsignformfieldgroups
ObjectEzsigndocumentApi ezsigndocument_get_ezsignpages_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages Retrieve an existing Ezsigndocument's Ezsignpages
ObjectEzsigndocumentApi ezsigndocument_get_ezsignsignatures_automatic_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsigndocument's automatic Ezsignsignatures
ObjectEzsigndocumentApi ezsigndocument_get_ezsignsignatures_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures Retrieve an existing Ezsigndocument's Ezsignsignatures
ObjectEzsigndocumentApi ezsigndocument_get_form_data_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData Retrieve an existing Ezsigndocument's Form Data
ObjectEzsigndocumentApi ezsigndocument_get_object_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
ObjectEzsigndocumentApi ezsigndocument_get_object_v2 GET /2/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
ObjectEzsigndocumentApi ezsigndocument_get_temporary_proof_v1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof Retrieve the temporary proof
ObjectEzsigndocumentApi ezsigndocument_get_words_positions_v1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigndocument
ObjectEzsigndocumentApi ezsigndocument_patch_object_v1 PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID} Patch an existing Ezsigndocument
ObjectEzsigndocumentApi ezsigndocument_submit_ezsignform_v1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform Submit the Ezsignform
ObjectEzsigndocumentApi ezsigndocument_unsend_v1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend Unsend the Ezsigndocument
ObjectEzsignfolderApi ezsignfolder_archive_v1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive Archive the Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_batch_download_v1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload Download multiples files from an Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_create_object_v1 POST /1/object/ezsignfolder Create a new Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_create_object_v2 POST /2/object/ezsignfolder Create a new Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_delete_object_v1 DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} Delete an existing Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_dispose_ezsignfolders_v1 POST /1/object/ezsignfolder/disposeEzsignfolders Dispose Ezsignfolders
ObjectEzsignfolderApi ezsignfolder_dispose_v1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose Dispose the Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_edit_object_v1 PUT /1/object/ezsignfolder/{pkiEzsignfolderID} Edit an existing Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_end_prematurely_v1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/endPrematurely End prematurely
ObjectEzsignfolderApi ezsignfolder_get_actionable_elements_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements Retrieve actionable elements for the Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_get_attachment_count_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount Retrieve Attachment count
ObjectEzsignfolderApi ezsignfolder_get_attachments_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments Retrieve Ezsignfolder's Attachments
ObjectEzsignfolderApi ezsignfolder_get_communication_count_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount Retrieve Communication count
ObjectEzsignfolderApi ezsignfolder_get_communication_list_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList Retrieve Communication list
ObjectEzsignfolderApi ezsignfolder_get_communicationrecipients_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients Retrieve Ezsignfolder's Communicationrecipient
ObjectEzsignfolderApi ezsignfolder_get_communicationsenders_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders Retrieve Ezsignfolder's Communicationsender
ObjectEzsignfolderApi ezsignfolder_get_ezsigndocuments_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments Retrieve an existing Ezsignfolder's Ezsigndocuments
ObjectEzsignfolderApi ezsignfolder_get_ezsignfoldersignerassociations_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
ObjectEzsignfolderApi ezsignfolder_get_ezsignsignatures_automatic_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
ObjectEzsignfolderApi ezsignfolder_get_forms_data_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData Retrieve an existing Ezsignfolder's forms data
ObjectEzsignfolderApi ezsignfolder_get_list_v1 GET /1/object/ezsignfolder/getList Retrieve Ezsignfolder list
ObjectEzsignfolderApi ezsignfolder_get_object_v1 GET /1/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_get_object_v2 GET /2/object/ezsignfolder/{pkiEzsignfolderID} Retrieve an existing Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_import_ezsignfoldersignerassociations_v1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_import_ezsigntemplatepackage_v1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage Import an Ezsigntemplatepackage in the Ezsignfolder.
ObjectEzsignfolderApi ezsignfolder_reorder_v1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder Reorder Ezsigndocuments in the Ezsignfolder
ObjectEzsignfolderApi ezsignfolder_send_v1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
ObjectEzsignfolderApi ezsignfolder_send_v3 POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send Send the Ezsignfolder to the signatories for signature
ObjectEzsignfolderApi ezsignfolder_unsend_v1 POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend Unsend the Ezsignfolder
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociation_create_embedded_url_v1 POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/createEmbeddedUrl Creates an Url to allow embedded signing
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociation_create_object_v1 POST /1/object/ezsignfoldersignerassociation Create a new Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociation_create_object_v2 POST /2/object/ezsignfoldersignerassociation Create a new Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociation_delete_object_v1 DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Delete an existing Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociation_edit_object_v1 PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Edit an existing Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociation_force_disconnect_v1 POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/forceDisconnect Disconnects the Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociation_get_in_person_login_url_v1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getInPersonLoginUrl Retrieve a Login Url to allow In-Person signing
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociation_get_object_v1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Retrieve an existing Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociation_get_object_v2 GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Retrieve an existing Ezsignfoldersignerassociation
ObjectEzsignfoldersignerassociationApi ezsignfoldersignerassociation_patch_object_v1 PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Patch an existing Ezsignfoldersignerassociation
ObjectEzsignfoldertypeApi ezsignfoldertype_create_object_v2 POST /2/object/ezsignfoldertype Create a new Ezsignfoldertype
ObjectEzsignfoldertypeApi ezsignfoldertype_edit_object_v1 PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Edit an existing Ezsignfoldertype
ObjectEzsignfoldertypeApi ezsignfoldertype_edit_object_v2 PUT /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Edit an existing Ezsignfoldertype
ObjectEzsignfoldertypeApi ezsignfoldertype_get_autocomplete_v2 GET /2/object/ezsignfoldertype/getAutocomplete/{sSelector} Retrieve Ezsignfoldertypes and IDs
ObjectEzsignfoldertypeApi ezsignfoldertype_get_list_v1 GET /1/object/ezsignfoldertype/getList Retrieve Ezsignfoldertype list
ObjectEzsignfoldertypeApi ezsignfoldertype_get_object_v2 GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype
ObjectEzsignfoldertypeApi ezsignfoldertype_get_object_v3 GET /3/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype
ObjectEzsignformfieldgroupApi ezsignformfieldgroup_create_object_v1 POST /1/object/ezsignformfieldgroup Create a new Ezsignformfieldgroup
ObjectEzsignformfieldgroupApi ezsignformfieldgroup_delete_object_v1 DELETE /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} Delete an existing Ezsignformfieldgroup
ObjectEzsignformfieldgroupApi ezsignformfieldgroup_edit_object_v1 PUT /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} Edit an existing Ezsignformfieldgroup
ObjectEzsignformfieldgroupApi ezsignformfieldgroup_get_object_v2 GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID} Retrieve an existing Ezsignformfieldgroup
ObjectEzsignpageApi ezsignpage_consult_v1 POST /1/object/ezsignpage/{pkiEzsignpageID}/consult Consult an Ezsignpage
ObjectEzsignsignatureApi ezsignsignature_create_object_v1 POST /1/object/ezsignsignature Create a new Ezsignsignature
ObjectEzsignsignatureApi ezsignsignature_create_object_v2 POST /2/object/ezsignsignature Create a new Ezsignsignature
ObjectEzsignsignatureApi ezsignsignature_delete_object_v1 DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} Delete an existing Ezsignsignature
ObjectEzsignsignatureApi ezsignsignature_edit_object_v1 PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} Edit an existing Ezsignsignature
ObjectEzsignsignatureApi ezsignsignature_get_ezsignsignatureattachment_v1 GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment Retrieve an existing Ezsignsignature's Ezsignsignatureattachments
ObjectEzsignsignatureApi ezsignsignature_get_ezsignsignatures_automatic_v1 GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic Retrieve all automatic Ezsignsignatures
ObjectEzsignsignatureApi ezsignsignature_get_object_v2 GET /2/object/ezsignsignature/{pkiEzsignsignatureID} Retrieve an existing Ezsignsignature
ObjectEzsignsignatureApi ezsignsignature_sign_v1 POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign Sign the Ezsignsignature
ObjectEzsignsignergroupApi ezsignsignergroup_create_object_v1 POST /1/object/ezsignsignergroup Create a new Ezsignsignergroup
ObjectEzsignsignergroupApi ezsignsignergroup_delete_object_v1 DELETE /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} Delete an existing Ezsignsignergroup
ObjectEzsignsignergroupApi ezsignsignergroup_edit_ezsignsignergroupmemberships_v1 PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships Edit multiple Ezsignsignergroupmemberships
ObjectEzsignsignergroupApi ezsignsignergroup_edit_object_v1 PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID} Edit an existing Ezsignsignergroup
ObjectEzsignsignergroupApi ezsignsignergroup_get_ezsignsignergroupmemberships_v1 GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships
ObjectEzsignsignergroupApi ezsignsignergroup_get_object_v2 GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID} Retrieve an existing Ezsignsignergroup
ObjectEzsignsignergroupmembershipApi ezsignsignergroupmembership_create_object_v1 POST /1/object/ezsignsignergroupmembership Create a new Ezsignsignergroupmembership
ObjectEzsignsignergroupmembershipApi ezsignsignergroupmembership_delete_object_v1 DELETE /1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} Delete an existing Ezsignsignergroupmembership
ObjectEzsignsignergroupmembershipApi ezsignsignergroupmembership_get_object_v2 GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} Retrieve an existing Ezsignsignergroupmembership
ObjectEzsignsigningreasonApi ezsignsigningreason_create_object_v1 POST /1/object/ezsignsigningreason Create a new Ezsignsigningreason
ObjectEzsignsigningreasonApi ezsignsigningreason_edit_object_v1 PUT /1/object/ezsignsigningreason/{pkiEzsignsigningreasonID} Edit an existing Ezsignsigningreason
ObjectEzsignsigningreasonApi ezsignsigningreason_get_autocomplete_v2 GET /2/object/ezsignsigningreason/getAutocomplete/{sSelector} Retrieve Ezsignsigningreasons and IDs
ObjectEzsignsigningreasonApi ezsignsigningreason_get_list_v1 GET /1/object/ezsignsigningreason/getList Retrieve Ezsignsigningreason list
ObjectEzsignsigningreasonApi ezsignsigningreason_get_object_v2 GET /2/object/ezsignsigningreason/{pkiEzsignsigningreasonID} Retrieve an existing Ezsignsigningreason
ObjectEzsigntemplateApi ezsigntemplate_copy_v1 POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy Copy the Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplate_create_object_v1 POST /1/object/ezsigntemplate Create a new Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplate_create_object_v2 POST /2/object/ezsigntemplate Create a new Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplate_delete_object_v1 DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID} Delete an existing Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplate_edit_object_v1 PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID} Edit an existing Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplate_edit_object_v2 PUT /2/object/ezsigntemplate/{pkiEzsigntemplateID} Edit an existing Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplate_get_autocomplete_v2 GET /2/object/ezsigntemplate/getAutocomplete/{sSelector} Retrieve Ezsigntemplates and IDs
ObjectEzsigntemplateApi ezsigntemplate_get_list_v1 GET /1/object/ezsigntemplate/getList Retrieve Ezsigntemplate list
ObjectEzsigntemplateApi ezsigntemplate_get_object_v1 GET /1/object/ezsigntemplate/{pkiEzsigntemplateID} Retrieve an existing Ezsigntemplate
ObjectEzsigntemplateApi ezsigntemplate_get_object_v2 GET /2/object/ezsigntemplate/{pkiEzsigntemplateID} Retrieve an existing Ezsigntemplate
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_create_object_v1 POST /1/object/ezsigntemplatedocument Create a new Ezsigntemplatedocument
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_edit_ezsigntemplateformfieldgroups_v1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups Edit multiple Ezsigntemplateformfieldgroups
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_edit_ezsigntemplatesignatures_v1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures Edit multiple Ezsigntemplatesignatures
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_edit_object_v1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Edit an existing Ezsigntemplatedocument
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_flatten_v1 POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten Flatten
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_get_ezsigntemplatedocumentpages_v1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_get_ezsigntemplateformfieldgroups_v1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplateformfieldgroups Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_get_ezsigntemplatesignatures_v1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_get_object_v2 GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Retrieve an existing Ezsigntemplatedocument
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_get_words_positions_v1 POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigntemplatedocument
ObjectEzsigntemplatedocumentApi ezsigntemplatedocument_patch_object_v1 PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Patch an existing Ezsigntemplatedocument
ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroup_create_object_v1 POST /1/object/ezsigntemplateformfieldgroup Create a new Ezsigntemplateformfieldgroup
ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroup_delete_object_v1 DELETE /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} Delete an existing Ezsigntemplateformfieldgroup
ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroup_edit_object_v1 PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} Edit an existing Ezsigntemplateformfieldgroup
ObjectEzsigntemplateformfieldgroupApi ezsigntemplateformfieldgroup_get_object_v2 GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID} Retrieve an existing Ezsigntemplateformfieldgroup
ObjectEzsigntemplateglobalApi ezsigntemplateglobal_get_autocomplete_v2 GET /2/object/ezsigntemplateglobal/getAutocomplete/{sSelector} Retrieve Ezsigntemplateglobals and IDs
ObjectEzsigntemplateglobalApi ezsigntemplateglobal_get_object_v2 GET /2/object/ezsigntemplateglobal/{pkiEzsigntemplateglobalID} Retrieve an existing Ezsigntemplateglobal
ObjectEzsigntemplatepackageApi ezsigntemplatepackage_create_object_v1 POST /1/object/ezsigntemplatepackage Create a new Ezsigntemplatepackage
ObjectEzsigntemplatepackageApi ezsigntemplatepackage_delete_object_v1 DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Delete an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackageApi ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners Edit multiple Ezsigntemplatepackagesigners
ObjectEzsigntemplatepackageApi ezsigntemplatepackage_edit_object_v1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Edit an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackageApi ezsigntemplatepackage_get_autocomplete_v2 GET /2/object/ezsigntemplatepackage/getAutocomplete/{sSelector} Retrieve Ezsigntemplatepackages and IDs
ObjectEzsigntemplatepackageApi ezsigntemplatepackage_get_list_v1 GET /1/object/ezsigntemplatepackage/getList Retrieve Ezsigntemplatepackage list
ObjectEzsigntemplatepackageApi ezsigntemplatepackage_get_object_v2 GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Retrieve an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackagemembershipApi ezsigntemplatepackagemembership_create_object_v1 POST /1/object/ezsigntemplatepackagemembership Create a new Ezsigntemplatepackagemembership
ObjectEzsigntemplatepackagemembershipApi ezsigntemplatepackagemembership_delete_object_v1 DELETE /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} Delete an existing Ezsigntemplatepackagemembership
ObjectEzsigntemplatepackagemembershipApi ezsigntemplatepackagemembership_get_object_v2 GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID} Retrieve an existing Ezsigntemplatepackagemembership
ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesigner_create_object_v1 POST /1/object/ezsigntemplatepackagesigner Create a new Ezsigntemplatepackagesigner
ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesigner_delete_object_v1 DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} Delete an existing Ezsigntemplatepackagesigner
ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesigner_edit_object_v1 PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} Edit an existing Ezsigntemplatepackagesigner
ObjectEzsigntemplatepackagesignerApi ezsigntemplatepackagesigner_get_object_v2 GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID} Retrieve an existing Ezsigntemplatepackagesigner
ObjectEzsigntemplatepackagesignermembershipApi ezsigntemplatepackagesignermembership_create_object_v1 POST /1/object/ezsigntemplatepackagesignermembership Create a new Ezsigntemplatepackagesignermembership
ObjectEzsigntemplatepackagesignermembershipApi ezsigntemplatepackagesignermembership_delete_object_v1 DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} Delete an existing Ezsigntemplatepackagesignermembership
ObjectEzsigntemplatepackagesignermembershipApi ezsigntemplatepackagesignermembership_get_object_v2 GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} Retrieve an existing Ezsigntemplatepackagesignermembership
ObjectEzsigntemplatesignatureApi ezsigntemplatesignature_create_object_v1 POST /1/object/ezsigntemplatesignature Create a new Ezsigntemplatesignature
ObjectEzsigntemplatesignatureApi ezsigntemplatesignature_delete_object_v1 DELETE /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Delete an existing Ezsigntemplatesignature
ObjectEzsigntemplatesignatureApi ezsigntemplatesignature_edit_object_v1 PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Edit an existing Ezsigntemplatesignature
ObjectEzsigntemplatesignatureApi ezsigntemplatesignature_get_object_v2 GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID} Retrieve an existing Ezsigntemplatesignature
ObjectEzsigntemplatesignerApi ezsigntemplatesigner_create_object_v1 POST /1/object/ezsigntemplatesigner Create a new Ezsigntemplatesigner
ObjectEzsigntemplatesignerApi ezsigntemplatesigner_delete_object_v1 DELETE /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Delete an existing Ezsigntemplatesigner
ObjectEzsigntemplatesignerApi ezsigntemplatesigner_edit_object_v1 PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Edit an existing Ezsigntemplatesigner
ObjectEzsigntemplatesignerApi ezsigntemplatesigner_get_object_v2 GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID} Retrieve an existing Ezsigntemplatesigner
ObjectEzsigntsarequirementApi ezsigntsarequirement_get_autocomplete_v2 GET /2/object/ezsigntsarequirement/getAutocomplete/{sSelector} Retrieve Ezsigntsarequirements and IDs
ObjectFontApi font_get_autocomplete_v2 GET /2/object/font/getAutocomplete/{sSelector} Retrieve Fonts and IDs
ObjectFranchisebrokerApi franchisebroker_get_autocomplete_v2 GET /2/object/franchisebroker/getAutocomplete/{sSelector} Retrieve Franchisebrokers and IDs
ObjectFranchiseofficeApi franchiseoffice_get_autocomplete_v2 GET /2/object/franchiseoffice/getAutocomplete/{sSelector} Retrieve Franchiseoffices and IDs
ObjectFranchisereferalincomeApi franchisereferalincome_create_object_v2 POST /2/object/franchisereferalincome Create a new Franchisereferalincome
ObjectInscriptionApi inscription_get_attachments_v1 GET /1/object/inscription/{pkiInscriptionID}/getAttachments Retrieve Inscription's Attachments
ObjectInscriptionApi inscription_get_communication_list_v1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList Retrieve Communication list
ObjectInscriptionApi inscription_get_communicationsenders_v1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationsenders Retrieve Inscription's Communicationsender
ObjectInscriptionnotauthenticatedApi inscriptionnotauthenticated_get_communication_list_v1 GET /1/object/inscriptionnotauthenticated/{pkiInscriptionnotauthenticatedID}/getCommunicationList Retrieve Communication list
ObjectInscriptiontempApi inscriptiontemp_get_communication_list_v1 GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList Retrieve Communication list
ObjectInvoiceApi invoice_get_attachments_v1 GET /1/object/invoice/{pkiInvoiceID}/getAttachments Retrieve Invoice's Attachments
ObjectInvoiceApi invoice_get_communication_list_v1 GET /1/object/invoice/{pkiInvoiceID}/getCommunicationList Retrieve Communication list
ObjectLanguageApi language_get_autocomplete_v2 GET /2/object/language/getAutocomplete/{sSelector} Retrieve Languages and IDs
ObjectModuleApi module_get_autocomplete_v2 GET /2/object/module/getAutocomplete/{sSelector} Retrieve Modules and IDs
ObjectModulegroupApi modulegroup_get_all_v1 GET /1/object/modulegroup/getAll/{eContext} Retrieve all Modulegroups
ObjectNotificationsectionApi notificationsection_get_notificationtests_v1 GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests Retrieve an existing Notificationsection's Notificationtests
ObjectNotificationtestApi notificationtest_get_elements_v1 GET /1/object/notificationtest/{pkiNotificationtestID}/getElements Retrieve an existing Notificationtest's Elements
ObjectOtherincomeApi otherincome_get_communication_list_v1 GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList Retrieve Communication list
ObjectPaymenttermApi paymentterm_create_object_v1 POST /1/object/paymentterm Create a new Paymentterm
ObjectPaymenttermApi paymentterm_edit_object_v1 PUT /1/object/paymentterm/{pkiPaymenttermID} Edit an existing Paymentterm
ObjectPaymenttermApi paymentterm_get_autocomplete_v2 GET /2/object/paymentterm/getAutocomplete/{sSelector} Retrieve Paymentterms and IDs
ObjectPaymenttermApi paymentterm_get_list_v1 GET /1/object/paymentterm/getList Retrieve Paymentterm list
ObjectPaymenttermApi paymentterm_get_object_v2 GET /2/object/paymentterm/{pkiPaymenttermID} Retrieve an existing Paymentterm
ObjectPeriodApi period_get_autocomplete_v2 GET /2/object/period/getAutocomplete/{sSelector} Retrieve Periods and IDs
ObjectPermissionApi permission_create_object_v1 POST /1/object/permission Create a new Permission
ObjectPermissionApi permission_delete_object_v1 DELETE /1/object/permission/{pkiPermissionID} Delete an existing Permission
ObjectPermissionApi permission_edit_object_v1 PUT /1/object/permission/{pkiPermissionID} Edit an existing Permission
ObjectPermissionApi permission_get_object_v2 GET /2/object/permission/{pkiPermissionID} Retrieve an existing Permission
ObjectPhonetypeApi phonetype_get_autocomplete_v2 GET /2/object/phonetype/getAutocomplete/{sSelector} Retrieve Phonetypes and IDs
ObjectProvinceApi province_get_autocomplete_v2 GET /2/object/province/getAutocomplete/{sSelector} Retrieve Provinces and IDs
ObjectRejectedoffertopurchaseApi rejectedoffertopurchase_get_communication_list_v1 GET /1/object/rejectedoffertopurchase/{pkiRejectedoffertopurchaseID}/getCommunicationList Retrieve Communication list
ObjectSecretquestionApi secretquestion_get_autocomplete_v2 GET /2/object/secretquestion/getAutocomplete/{sSelector} Retrieve Secretquestions and IDs
ObjectSessionhistoryApi sessionhistory_get_list_v1 GET /1/object/sessionhistory/getList Retrieve Sessionhistory list
ObjectSignatureApi signature_create_object_v1 POST /1/object/signature Create a new Signature
ObjectSignatureApi signature_delete_object_v1 DELETE /1/object/signature/{pkiSignatureID} Delete an existing Signature
ObjectSignatureApi signature_edit_object_v1 PUT /1/object/signature/{pkiSignatureID} Edit an existing Signature
ObjectSignatureApi signature_get_object_v2 GET /2/object/signature/{pkiSignatureID} Retrieve an existing Signature
ObjectSubnetApi subnet_create_object_v1 POST /1/object/subnet Create a new Subnet
ObjectSubnetApi subnet_delete_object_v1 DELETE /1/object/subnet/{pkiSubnetID} Delete an existing Subnet
ObjectSubnetApi subnet_edit_object_v1 PUT /1/object/subnet/{pkiSubnetID} Edit an existing Subnet
ObjectSubnetApi subnet_get_object_v2 GET /2/object/subnet/{pkiSubnetID} Retrieve an existing Subnet
ObjectSystemconfigurationApi systemconfiguration_edit_object_v1 PUT /1/object/systemconfiguration/{pkiSystemconfigurationID} Edit an existing Systemconfiguration
ObjectSystemconfigurationApi systemconfiguration_get_object_v2 GET /2/object/systemconfiguration/{pkiSystemconfigurationID} Retrieve an existing Systemconfiguration
ObjectTaxassignmentApi taxassignment_get_autocomplete_v2 GET /2/object/taxassignment/getAutocomplete/{sSelector} Retrieve Taxassignments and IDs
ObjectTimezoneApi timezone_get_autocomplete_v2 GET /2/object/timezone/getAutocomplete/{sSelector} Retrieve Timezones and IDs
ObjectUserApi user_create_object_v1 POST /1/object/user Create a new User
ObjectUserApi user_create_object_v2 POST /2/object/user Create a new User
ObjectUserApi user_edit_object_v1 PUT /1/object/user/{pkiUserID} Edit an existing User
ObjectUserApi user_edit_permissions_v1 PUT /1/object/user/{pkiUserID}/editPermissions Edit multiple Permissions
ObjectUserApi user_get_apikeys_v1 GET /1/object/user/{pkiUserID}/getApikeys Retrieve an existing User's Apikeys
ObjectUserApi user_get_autocomplete_v2 GET /2/object/user/getAutocomplete/{sSelector} Retrieve Users and IDs
ObjectUserApi user_get_effective_permissions_v1 GET /1/object/user/{pkiUserID}/getEffectivePermissions Retrieve an existing User's Effective Permissions
ObjectUserApi user_get_list_v1 GET /1/object/user/getList Retrieve User list
ObjectUserApi user_get_object_v2 GET /2/object/user/{pkiUserID} Retrieve an existing User
ObjectUserApi user_get_permissions_v1 GET /1/object/user/{pkiUserID}/getPermissions Retrieve an existing User's Permissions
ObjectUserApi user_get_subnets_v1 GET /1/object/user/{pkiUserID}/getSubnets Retrieve an existing User's Subnets
ObjectUserApi user_get_usergroupexternals_v1 GET /1/object/user/{pkiUserID}/getUsergroupexternals Get User's Usergroupexternals
ObjectUserApi user_get_usergroups_v1 GET /1/object/user/{pkiUserID}/getUsergroups Get User's Usergroups
ObjectUserApi user_send_password_reset_v1 POST /1/object/user/{pkiUserID}/sendPasswordReset Send password reset
ObjectUsergroupApi usergroup_create_object_v1 POST /1/object/usergroup Create a new Usergroup
ObjectUsergroupApi usergroup_edit_object_v1 PUT /1/object/usergroup/{pkiUsergroupID} Edit an existing Usergroup
ObjectUsergroupApi usergroup_edit_permissions_v1 PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions Edit multiple Permissions
ObjectUsergroupApi usergroup_edit_usergroupdelegations_v1 PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations Edit multiple Usergroupdelegations
ObjectUsergroupApi usergroup_edit_usergroupmemberships_v1 PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships Edit multiple Usergroupmemberships
ObjectUsergroupApi usergroup_get_autocomplete_v2 GET /2/object/usergroup/getAutocomplete/{sSelector} Retrieve Usergroups and IDs
ObjectUsergroupApi usergroup_get_list_v1 GET /1/object/usergroup/getList Retrieve Usergroup list
ObjectUsergroupApi usergroup_get_object_v2 GET /2/object/usergroup/{pkiUsergroupID} Retrieve an existing Usergroup
ObjectUsergroupApi usergroup_get_permissions_v1 GET /1/object/usergroup/{pkiUsergroupID}/getPermissions Retrieve an existing Usergroup's Permissions
ObjectUsergroupApi usergroup_get_usergroupdelegations_v1 GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations Retrieve an existing Usergroup's Usergroupdelegations
ObjectUsergroupApi usergroup_get_usergroupmemberships_v1 GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships Retrieve an existing Usergroup's Usergroupmemberships
ObjectUsergroupdelegationApi usergroupdelegation_create_object_v1 POST /1/object/usergroupdelegation Create a new Usergroupdelegation
ObjectUsergroupdelegationApi usergroupdelegation_delete_object_v1 DELETE /1/object/usergroupdelegation/{pkiUsergroupdelegationID} Delete an existing Usergroupdelegation
ObjectUsergroupdelegationApi usergroupdelegation_edit_object_v1 PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID} Edit an existing Usergroupdelegation
ObjectUsergroupdelegationApi usergroupdelegation_get_object_v2 GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID} Retrieve an existing Usergroupdelegation
ObjectUsergroupexternalApi usergroupexternal_create_object_v1 POST /1/object/usergroupexternal Create a new Usergroupexternal
ObjectUsergroupexternalApi usergroupexternal_delete_object_v1 DELETE /1/object/usergroupexternal/{pkiUsergroupexternalID} Delete an existing Usergroupexternal
ObjectUsergroupexternalApi usergroupexternal_edit_object_v1 PUT /1/object/usergroupexternal/{pkiUsergroupexternalID} Edit an existing Usergroupexternal
ObjectUsergroupexternalApi usergroupexternal_get_autocomplete_v2 GET /2/object/usergroupexternal/getAutocomplete/{sSelector} Retrieve Usergroupexternals and IDs
ObjectUsergroupexternalApi usergroupexternal_get_list_v1 GET /1/object/usergroupexternal/getList Retrieve Usergroupexternal list
ObjectUsergroupexternalApi usergroupexternal_get_object_v2 GET /2/object/usergroupexternal/{pkiUsergroupexternalID} Retrieve an existing Usergroupexternal
ObjectUsergroupexternalApi usergroupexternal_get_usergroupexternalmemberships_v1 GET /1/object/usergroupexternal/{pkiUsergroupexternalID}/getUsergroupexternalmemberships Retrieve an existing Usergroupexternal's Usergroupexternalmemberships
ObjectUsergroupexternalApi usergroupexternal_get_usergroups_v1 GET /1/object/usergroupexternal/{pkiUsergroupexternalID}/getUsergroups Get Usergroupexternal's Usergroups
ObjectUsergroupmembershipApi usergroupmembership_create_object_v1 POST /1/object/usergroupmembership Create a new Usergroupmembership
ObjectUsergroupmembershipApi usergroupmembership_delete_object_v1 DELETE /1/object/usergroupmembership/{pkiUsergroupmembershipID} Delete an existing Usergroupmembership
ObjectUsergroupmembershipApi usergroupmembership_edit_object_v1 PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID} Edit an existing Usergroupmembership
ObjectUsergroupmembershipApi usergroupmembership_get_object_v2 GET /2/object/usergroupmembership/{pkiUsergroupmembershipID} Retrieve an existing Usergroupmembership
ObjectUserlogintypeApi userlogintype_get_autocomplete_v2 GET /2/object/userlogintype/getAutocomplete/{sSelector} Retrieve Userlogintypes and IDs
ObjectUserstagedApi userstaged_create_user_v1 POST /1/object/userstaged/{pkiUserstagedID}/createUser Create a User from a Userstaged and then map it
ObjectUserstagedApi userstaged_delete_object_v1 DELETE /1/object/userstaged/{pkiUserstagedID} Delete an existing Userstaged
ObjectUserstagedApi userstaged_get_list_v1 GET /1/object/userstaged/getList Retrieve Userstaged list
ObjectUserstagedApi userstaged_get_object_v2 GET /2/object/userstaged/{pkiUserstagedID} Retrieve an existing Userstaged
ObjectUserstagedApi userstaged_map_v1 POST /1/object/userstaged/{pkiUserstagedID}/map Map the Userstaged to an existing user
ObjectVariableexpenseApi variableexpense_create_object_v1 POST /1/object/variableexpense Create a new Variableexpense
ObjectVariableexpenseApi variableexpense_edit_object_v1 PUT /1/object/variableexpense/{pkiVariableexpenseID} Edit an existing Variableexpense
ObjectVariableexpenseApi variableexpense_get_autocomplete_v2 GET /2/object/variableexpense/getAutocomplete/{sSelector} Retrieve Variableexpenses and IDs
ObjectVariableexpenseApi variableexpense_get_list_v1 GET /1/object/variableexpense/getList Retrieve Variableexpense list
ObjectVariableexpenseApi variableexpense_get_object_v2 GET /2/object/variableexpense/{pkiVariableexpenseID} Retrieve an existing Variableexpense
ObjectVersionhistoryApi versionhistory_get_object_v2 GET /2/object/versionhistory/{pkiVersionhistoryID} Retrieve an existing Versionhistory
ObjectWebhookApi webhook_create_object_v2 POST /2/object/webhook Create a new Webhook
ObjectWebhookApi webhook_delete_object_v1 DELETE /1/object/webhook/{pkiWebhookID} Delete an existing Webhook
ObjectWebhookApi webhook_edit_object_v1 PUT /1/object/webhook/{pkiWebhookID} Edit an existing Webhook
ObjectWebhookApi webhook_get_history_v1 GET /1/object/webhook/{pkiWebhookID}/getHistory Retrieve the logs for recent Webhook calls
ObjectWebhookApi webhook_get_list_v1 GET /1/object/webhook/getList Retrieve Webhook list
ObjectWebhookApi webhook_get_object_v2 GET /2/object/webhook/{pkiWebhookID} Retrieve an existing Webhook
ObjectWebhookApi webhook_regenerate_apikey_v1 POST /1/object/webhook/{pkiWebhookID}/regenerateApikey Regenerate the Apikey
ObjectWebhookApi webhook_test_v1 POST /1/object/webhook/{pkiWebhookID}/test Test the Webhook by calling the Url
ScimGroupsApi groups_create_object_scim_v2 POST /2/scim/Groups Create a new Usergroup
ScimGroupsApi groups_delete_object_scim_v2 DELETE /2/scim/Groups/{groupId} Delete an existing Usergroup
ScimGroupsApi groups_edit_object_scim_v2 PUT /2/scim/Groups/{groupId} Edit an existing Usergroup
ScimGroupsApi groups_get_list_scim_v2 GET /2/scim/Groups Retrieve Usergroup list
ScimGroupsApi groups_get_object_scim_v2 GET /2/scim/Groups/{groupId} Retrieve an existing Usergroup
ScimServiceProviderConfigApi service_provider_config_get_object_scim_v2 GET /2/scim/ServiceProviderConfig Get Service Provider Configuration
ScimUsersApi users_create_object_scim_v2 POST /2/scim/Users Create a new User
ScimUsersApi users_delete_object_scim_v2 DELETE /2/scim/Users/{userId} Delete an existing User
ScimUsersApi users_edit_object_scim_v2 PUT /2/scim/Users/{userId} Edit an existing User
ScimUsersApi users_get_list_scim_v2 GET /2/scim/Users Retrieve User list
ScimUsersApi users_get_object_scim_v2 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

Author

support-api@ezmax.ca