Skip to content

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

Notifications You must be signed in to change notification settings

eZmaxinc/eZmax-SDK-csharp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

eZmaxApi - the C# library for the eZmax API Definition (Full)

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

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.2.0
  • SDK version: 1.2.0
  • Generator version: 7.4.0
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://www.ezmax.ca/en/contact

Frameworks supported

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out eZmaxApi.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            var apiInstance = new GlobalCustomerApi(config);
            var pksCustomerCode = "pksCustomerCode_example";  // string | 
            var sInfrastructureproductCode = "appcluster01";  // string? | The infrastructure product Code  If undefined, \"appcluster01\" is assumed (optional) 

            try
            {
                // Get customer endpoint
                GlobalCustomerGetEndpointV1Response result = apiInstance.GlobalCustomerGetEndpointV1(pksCustomerCode, sInfrastructureproductCode);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling GlobalCustomerApi.GlobalCustomerGetEndpointV1: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

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 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

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