All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
| Method | HTTP request | Description |
|---|---|---|
| ezsignfolderArchiveV1 | POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive | Archive the Ezsignfolder |
| ezsignfolderBatchDownloadV1 | POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload | Download multiples files from an Ezsignfolder |
| ezsignfolderCreateObjectV1 | POST /1/object/ezsignfolder | Create a new Ezsignfolder |
| ezsignfolderCreateObjectV2 | POST /2/object/ezsignfolder | Create a new Ezsignfolder |
| ezsignfolderCreateObjectV3 | POST /3/object/ezsignfolder | Create a new Ezsignfolder |
| ezsignfolderDeleteObjectV1 | DELETE /1/object/ezsignfolder/{pkiEzsignfolderID} | Delete an existing Ezsignfolder |
| ezsignfolderDisposeEzsignfoldersV1 | POST /1/object/ezsignfolder/disposeEzsignfolders | Dispose Ezsignfolders |
| ezsignfolderDisposeV1 | POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose | Dispose the Ezsignfolder |
| ezsignfolderEditObjectV3 | PUT /3/object/ezsignfolder/{pkiEzsignfolderID} | Edit an existing Ezsignfolder |
| ezsignfolderEndPrematurelyV1 | POST /1/object/ezsignfolder/{pkiEzsignfolderID}/endPrematurely | End prematurely |
| ezsignfolderGetActionableElementsV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements | Retrieve actionable elements for the Ezsignfolder |
| ezsignfolderGetActionableElementsV2 | GET /2/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements | Retrieve actionable elements for the Ezsignfolder |
| ezsignfolderGetActionableElementsV3 | GET /3/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements | Retrieve actionable elements for the Ezsignfolder |
| ezsignfolderGetAttachmentCountV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount | Retrieve Attachment count |
| ezsignfolderGetAttachmentsV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments | Retrieve Ezsignfolder's Attachments |
| ezsignfolderGetCommunicationCountV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount | Retrieve Communication count |
| ezsignfolderGetCommunicationListV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList | Retrieve Communication list |
| ezsignfolderGetCommunicationrecipientsV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients | Retrieve Ezsignfolder's Communicationrecipient |
| ezsignfolderGetCommunicationsendersV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders | Retrieve Ezsignfolder's Communicationsender |
| ezsignfolderGetEzsigndocumentsV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments | Retrieve an existing Ezsignfolder's Ezsigndocuments |
| ezsignfolderGetEzsigndocumentsV2 | GET /2/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments | Retrieve an existing Ezsignfolder's Ezsigndocuments |
| ezsignfolderGetEzsignfoldersignerassociationsV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations | Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations |
| ezsignfolderGetEzsignsignaturesAutomaticV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic | Retrieve an existing Ezsignfolder's automatic Ezsignsignatures |
| ezsignfolderGetFormsDataV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData | Retrieve an existing Ezsignfolder's forms data |
| ezsignfolderGetListV1 | GET /1/object/ezsignfolder/getList | Retrieve Ezsignfolder list |
| ezsignfolderGetObjectV1 | GET /1/object/ezsignfolder/{pkiEzsignfolderID} | Retrieve an existing Ezsignfolder |
| ezsignfolderGetObjectV2 | GET /2/object/ezsignfolder/{pkiEzsignfolderID} | Retrieve an existing Ezsignfolder |
| ezsignfolderGetObjectV3 | GET /3/object/ezsignfolder/{pkiEzsignfolderID} | Retrieve an existing Ezsignfolder |
| ezsignfolderImportEzsignfoldersignerassociationsV1 | POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations | Import an existing Ezsignfoldersignerassociation into this Ezsignfolder |
| ezsignfolderImportEzsigntemplatepackageV1 | POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage | Import an Ezsigntemplatepackage in the Ezsignfolder |
| ezsignfolderImportEzsigntemplatepackageV2 | POST /2/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage | Import an Ezsigntemplatepackage in the Ezsignfolder |
| ezsignfolderReorderV2 | POST /2/object/ezsignfolder/{pkiEzsignfolderID}/reorder | Reorder Ezsigndocuments in the Ezsignfolder |
| ezsignfolderSendV1 | POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send | Send the Ezsignfolder to the signatories for signature |
| ezsignfolderSendV3 | POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send | Send the Ezsignfolder to the signatories for signature |
| ezsignfolderUnsendV1 | POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend | Unsend the Ezsignfolder |
EzsignfolderArchiveV1Response ezsignfolderArchiveV1(pkiEzsignfolderID, body)
Archive the Ezsignfolder
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
Object body = null; // Object |
try {
EzsignfolderArchiveV1Response result = apiInstance.ezsignfolderArchiveV1(pkiEzsignfolderID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderArchiveV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| body | Object |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
File ezsignfolderBatchDownloadV1(pkiEzsignfolderID, ezsignfolderBatchDownloadV1Request)
Download multiples files from an Ezsignfolder
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
EzsignfolderBatchDownloadV1Request ezsignfolderBatchDownloadV1Request = new EzsignfolderBatchDownloadV1Request(); // EzsignfolderBatchDownloadV1Request |
try {
File result = apiInstance.ezsignfolderBatchDownloadV1(pkiEzsignfolderID, ezsignfolderBatchDownloadV1Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderBatchDownloadV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| ezsignfolderBatchDownloadV1Request | EzsignfolderBatchDownloadV1Request |
- Content-Type: application/json
- Accept: application/zip, application/pdf, application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 406 | The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png" | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderCreateObjectV1Response ezsignfolderCreateObjectV1(ezsignfolderCreateObjectV1Request)
Create a new Ezsignfolder
The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects.
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
List<EzsignfolderCreateObjectV1Request> ezsignfolderCreateObjectV1Request = Arrays.asList(); // List<EzsignfolderCreateObjectV1Request> |
try {
EzsignfolderCreateObjectV1Response result = apiInstance.ezsignfolderCreateObjectV1(ezsignfolderCreateObjectV1Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderCreateObjectV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ezsignfolderCreateObjectV1Request | List<EzsignfolderCreateObjectV1Request> |
EzsignfolderCreateObjectV1Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
EzsignfolderCreateObjectV2Response ezsignfolderCreateObjectV2(ezsignfolderCreateObjectV2Request)
Create a new Ezsignfolder
The endpoint allows to create one or many elements at once.
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
EzsignfolderCreateObjectV2Request ezsignfolderCreateObjectV2Request = new EzsignfolderCreateObjectV2Request(); // EzsignfolderCreateObjectV2Request |
try {
EzsignfolderCreateObjectV2Response result = apiInstance.ezsignfolderCreateObjectV2(ezsignfolderCreateObjectV2Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderCreateObjectV2");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ezsignfolderCreateObjectV2Request | EzsignfolderCreateObjectV2Request |
EzsignfolderCreateObjectV2Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
EzsignfolderCreateObjectV3Response ezsignfolderCreateObjectV3(ezsignfolderCreateObjectV3Request)
Create a new Ezsignfolder
The endpoint allows to create one or many elements at once.
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
EzsignfolderCreateObjectV3Request ezsignfolderCreateObjectV3Request = new EzsignfolderCreateObjectV3Request(); // EzsignfolderCreateObjectV3Request |
try {
EzsignfolderCreateObjectV3Response result = apiInstance.ezsignfolderCreateObjectV3(ezsignfolderCreateObjectV3Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderCreateObjectV3");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ezsignfolderCreateObjectV3Request | EzsignfolderCreateObjectV3Request |
EzsignfolderCreateObjectV3Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful response | - |
EzsignfolderDeleteObjectV1Response ezsignfolderDeleteObjectV1(pkiEzsignfolderID)
Delete an existing Ezsignfolder
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderDeleteObjectV1Response result = apiInstance.ezsignfolderDeleteObjectV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderDeleteObjectV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderDeleteObjectV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderDisposeEzsignfoldersV1Response ezsignfolderDisposeEzsignfoldersV1(ezsignfolderDisposeEzsignfoldersV1Request)
Dispose Ezsignfolders
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
EzsignfolderDisposeEzsignfoldersV1Request ezsignfolderDisposeEzsignfoldersV1Request = new EzsignfolderDisposeEzsignfoldersV1Request(); // EzsignfolderDisposeEzsignfoldersV1Request |
try {
EzsignfolderDisposeEzsignfoldersV1Response result = apiInstance.ezsignfolderDisposeEzsignfoldersV1(ezsignfolderDisposeEzsignfoldersV1Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderDisposeEzsignfoldersV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ezsignfolderDisposeEzsignfoldersV1Request | EzsignfolderDisposeEzsignfoldersV1Request |
EzsignfolderDisposeEzsignfoldersV1Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderDisposeV1Response ezsignfolderDisposeV1(pkiEzsignfolderID, body)
Dispose the Ezsignfolder
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
Object body = null; // Object |
try {
EzsignfolderDisposeV1Response result = apiInstance.ezsignfolderDisposeV1(pkiEzsignfolderID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderDisposeV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| body | Object |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderEditObjectV3Response ezsignfolderEditObjectV3(pkiEzsignfolderID, ezsignfolderEditObjectV3Request)
Edit an existing Ezsignfolder
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
EzsignfolderEditObjectV3Request ezsignfolderEditObjectV3Request = new EzsignfolderEditObjectV3Request(); // EzsignfolderEditObjectV3Request |
try {
EzsignfolderEditObjectV3Response result = apiInstance.ezsignfolderEditObjectV3(pkiEzsignfolderID, ezsignfolderEditObjectV3Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderEditObjectV3");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| ezsignfolderEditObjectV3Request | EzsignfolderEditObjectV3Request |
EzsignfolderEditObjectV3Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderEndPrematurelyV1Response ezsignfolderEndPrematurelyV1(pkiEzsignfolderID, body)
End prematurely
End prematurely all Ezsigndocument of Ezsignfolder when some signatures are still required
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
Object body = null; // Object |
try {
EzsignfolderEndPrematurelyV1Response result = apiInstance.ezsignfolderEndPrematurelyV1(pkiEzsignfolderID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderEndPrematurelyV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| body | Object |
EzsignfolderEndPrematurelyV1Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderGetActionableElementsV1Response ezsignfolderGetActionableElementsV1(pkiEzsignfolderID)
Retrieve actionable elements for the Ezsignfolder
Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process. Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetActionableElementsV1Response result = apiInstance.ezsignfolderGetActionableElementsV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetActionableElementsV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetActionableElementsV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderGetActionableElementsV2Response ezsignfolderGetActionableElementsV2(pkiEzsignfolderID)
Retrieve actionable elements for the Ezsignfolder
Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetActionableElementsV2Response result = apiInstance.ezsignfolderGetActionableElementsV2(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetActionableElementsV2");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetActionableElementsV2Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderGetActionableElementsV3Response ezsignfolderGetActionableElementsV3(pkiEzsignfolderID)
Retrieve actionable elements for the Ezsignfolder
Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetActionableElementsV3Response result = apiInstance.ezsignfolderGetActionableElementsV3(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetActionableElementsV3");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetActionableElementsV3Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderGetAttachmentCountV1Response ezsignfolderGetAttachmentCountV1(pkiEzsignfolderID)
Retrieve Attachment count
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetAttachmentCountV1Response result = apiInstance.ezsignfolderGetAttachmentCountV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetAttachmentCountV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetAttachmentCountV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetAttachmentsV1Response ezsignfolderGetAttachmentsV1(pkiEzsignfolderID)
Retrieve Ezsignfolder's Attachments
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetAttachmentsV1Response result = apiInstance.ezsignfolderGetAttachmentsV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetAttachmentsV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetAttachmentsV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetCommunicationCountV1Response ezsignfolderGetCommunicationCountV1(pkiEzsignfolderID)
Retrieve Communication count
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetCommunicationCountV1Response result = apiInstance.ezsignfolderGetCommunicationCountV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationCountV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetCommunicationCountV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetCommunicationListV1Response ezsignfolderGetCommunicationListV1(pkiEzsignfolderID)
Retrieve Communication list
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetCommunicationListV1Response result = apiInstance.ezsignfolderGetCommunicationListV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationListV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetCommunicationListV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetCommunicationrecipientsV1Response ezsignfolderGetCommunicationrecipientsV1(pkiEzsignfolderID)
Retrieve Ezsignfolder's Communicationrecipient
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetCommunicationrecipientsV1Response result = apiInstance.ezsignfolderGetCommunicationrecipientsV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationrecipientsV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetCommunicationrecipientsV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetCommunicationsendersV1Response ezsignfolderGetCommunicationsendersV1(pkiEzsignfolderID)
Retrieve Ezsignfolder's Communicationsender
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetCommunicationsendersV1Response result = apiInstance.ezsignfolderGetCommunicationsendersV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationsendersV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetCommunicationsendersV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetEzsigndocumentsV1Response ezsignfolderGetEzsigndocumentsV1(pkiEzsignfolderID)
Retrieve an existing Ezsignfolder's Ezsigndocuments
Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetEzsigndocumentsV1Response result = apiInstance.ezsignfolderGetEzsigndocumentsV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetEzsigndocumentsV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetEzsigndocumentsV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetEzsigndocumentsV2Response ezsignfolderGetEzsigndocumentsV2(pkiEzsignfolderID)
Retrieve an existing Ezsignfolder's Ezsigndocuments
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetEzsigndocumentsV2Response result = apiInstance.ezsignfolderGetEzsigndocumentsV2(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetEzsigndocumentsV2");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetEzsigndocumentsV2Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetEzsignfoldersignerassociationsV1Response ezsignfolderGetEzsignfoldersignerassociationsV1(pkiEzsignfolderID)
Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetEzsignfoldersignerassociationsV1Response result = apiInstance.ezsignfolderGetEzsignfoldersignerassociationsV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetEzsignfoldersignerassociationsV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetEzsignfoldersignerassociationsV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetEzsignsignaturesAutomaticV1Response ezsignfolderGetEzsignsignaturesAutomaticV1(pkiEzsignfolderID)
Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
Return the Ezsignsignatures that can be signed by the current user at the current step in the process
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetEzsignsignaturesAutomaticV1Response result = apiInstance.ezsignfolderGetEzsignsignaturesAutomaticV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetEzsignsignaturesAutomaticV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetEzsignsignaturesAutomaticV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetFormsDataV1Response ezsignfolderGetFormsDataV1(pkiEzsignfolderID)
Retrieve an existing Ezsignfolder's forms data
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetFormsDataV1Response result = apiInstance.ezsignfolderGetFormsDataV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetFormsDataV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetFormsDataV1Response
- Content-Type: Not defined
- Accept: application/json, application/zip
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 406 | The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png" | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderGetListV1Response ezsignfolderGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)
Retrieve Ezsignfolder list
Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent<br>Sent<br>PartiallySigned<br>Expired<br>Completed<br>Archived<br>Disposed| | eEzsignfoldertypePrivacylevel | User<br>Usergroup | Advanced filters that can be used in query parameter sFilter: | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sUserFirstname | | sUserLastname | | sEzsigndocumentName |
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
String eOrderBy = "pkiEzsignfolderID_ASC"; // String | Specify how you want the results to be sorted
Integer iRowMax = 56; // Integer |
Integer iRowOffset = 0; // Integer |
HeaderAcceptLanguage acceptLanguage = HeaderAcceptLanguage.fromValue("*"); // HeaderAcceptLanguage |
String sFilter = "sFilter_example"; // String |
try {
EzsignfolderGetListV1Response result = apiInstance.ezsignfolderGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetListV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| eOrderBy | String | Specify how you want the results to be sorted | [optional] [enum: pkiEzsignfolderID_ASC, pkiEzsignfolderID_DESC, sEzsignfolderDescription_ASC, sEzsignfolderDescription_DESC, dtCreatedDate_ASC, dtCreatedDate_DESC, fkiEzsignfoldertypeID_ASC, fkiEzsignfoldertypeID_DESC, sEzsignfoldertypeNameX_ASC, sEzsignfoldertypeNameX_DESC, eEzsignfolderStep_ASC, eEzsignfolderStep_DESC, eEzsignfolderCompletion_ASC, eEzsignfolderCompletion_DESC, dtEzsignfolderSentdate_ASC, dtEzsignfolderSentdate_DESC, dtEzsignfolderDuedate_ASC, dtEzsignfolderDuedate_DESC, iEzsigndocument_ASC, iEzsigndocument_DESC, iEzsigndocumentEdm_ASC, iEzsigndocumentEdm_DESC, iEzsignsignature_ASC, iEzsignsignature_DESC, iEzsignsignatureSigned_ASC, iEzsignsignatureSigned_DESC, iEzsignformfieldgroup_ASC, iEzsignformfieldgroup_DESC, iEzsignformfieldgroupCompleted_ASC, iEzsignformfieldgroupCompleted_DESC, dEzsignfolderCompletedpercentage_ASC, dEzsignfolderCompletedpercentage_DESC, dEzsignfolderFormcompletedpercentage_ASC, dEzsignfolderFormcompletedpercentage_DESC, dEzsignfolderSignaturecompletedpercentage_ASC, dEzsignfolderSignaturecompletedpercentagee_DESC] |
| iRowMax | Integer | [optional] | |
| iRowOffset | Integer | [optional] [default to 0] | |
| acceptLanguage | HeaderAcceptLanguage | [optional] [enum: *, en, fr] | |
| sFilter | String | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 406 | The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png" | - |
EzsignfolderGetObjectV1Response ezsignfolderGetObjectV1(pkiEzsignfolderID)
Retrieve an existing Ezsignfolder
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetObjectV1Response result = apiInstance.ezsignfolderGetObjectV1(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetObjectV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetObjectV1Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetObjectV2Response ezsignfolderGetObjectV2(pkiEzsignfolderID)
Retrieve an existing Ezsignfolder
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetObjectV2Response result = apiInstance.ezsignfolderGetObjectV2(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetObjectV2");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetObjectV2Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderGetObjectV3Response ezsignfolderGetObjectV3(pkiEzsignfolderID)
Retrieve an existing Ezsignfolder
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
try {
EzsignfolderGetObjectV3Response result = apiInstance.ezsignfolderGetObjectV3(pkiEzsignfolderID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderGetObjectV3");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer |
EzsignfolderGetObjectV3Response
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
EzsignfolderImportEzsignfoldersignerassociationsV1Response ezsignfolderImportEzsignfoldersignerassociationsV1(pkiEzsignfolderID, ezsignfolderImportEzsignfoldersignerassociationsV1Request)
Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
EzsignfolderImportEzsignfoldersignerassociationsV1Request ezsignfolderImportEzsignfoldersignerassociationsV1Request = new EzsignfolderImportEzsignfoldersignerassociationsV1Request(); // EzsignfolderImportEzsignfoldersignerassociationsV1Request |
try {
EzsignfolderImportEzsignfoldersignerassociationsV1Response result = apiInstance.ezsignfolderImportEzsignfoldersignerassociationsV1(pkiEzsignfolderID, ezsignfolderImportEzsignfoldersignerassociationsV1Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderImportEzsignfoldersignerassociationsV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| ezsignfolderImportEzsignfoldersignerassociationsV1Request | EzsignfolderImportEzsignfoldersignerassociationsV1Request |
EzsignfolderImportEzsignfoldersignerassociationsV1Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 403 | The request is not allowed to be executed. Look for detail about the error in the body | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderImportEzsigntemplatepackageV1Response ezsignfolderImportEzsigntemplatepackageV1(pkiEzsignfolderID, ezsignfolderImportEzsigntemplatepackageV1Request)
Import an Ezsigntemplatepackage in the Ezsignfolder
This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step. Major step overhaul. Endpoints that existed before version 1.3 do not allow you to combine forms and signatures in the same step. The step numbers are different from those indicated by endpoints added since version 1.3. This endpoint is compatible with endpoints that existed before 1.3 but are not compatible with those added since 1.3.
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
EzsignfolderImportEzsigntemplatepackageV1Request ezsignfolderImportEzsigntemplatepackageV1Request = new EzsignfolderImportEzsigntemplatepackageV1Request(); // EzsignfolderImportEzsigntemplatepackageV1Request |
try {
EzsignfolderImportEzsigntemplatepackageV1Response result = apiInstance.ezsignfolderImportEzsigntemplatepackageV1(pkiEzsignfolderID, ezsignfolderImportEzsigntemplatepackageV1Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderImportEzsigntemplatepackageV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| ezsignfolderImportEzsigntemplatepackageV1Request | EzsignfolderImportEzsigntemplatepackageV1Request |
EzsignfolderImportEzsigntemplatepackageV1Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderImportEzsigntemplatepackageV2Response ezsignfolderImportEzsigntemplatepackageV2(pkiEzsignfolderID, ezsignfolderImportEzsigntemplatepackageV2Request)
Import an Ezsigntemplatepackage in the Ezsignfolder
This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step.
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
EzsignfolderImportEzsigntemplatepackageV2Request ezsignfolderImportEzsigntemplatepackageV2Request = new EzsignfolderImportEzsigntemplatepackageV2Request(); // EzsignfolderImportEzsigntemplatepackageV2Request |
try {
EzsignfolderImportEzsigntemplatepackageV2Response result = apiInstance.ezsignfolderImportEzsigntemplatepackageV2(pkiEzsignfolderID, ezsignfolderImportEzsigntemplatepackageV2Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderImportEzsigntemplatepackageV2");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| ezsignfolderImportEzsigntemplatepackageV2Request | EzsignfolderImportEzsigntemplatepackageV2Request |
EzsignfolderImportEzsigntemplatepackageV2Response
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderReorderV2Response ezsignfolderReorderV2(pkiEzsignfolderID, ezsignfolderReorderV2Request)
Reorder Ezsigndocuments in the Ezsignfolder
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
EzsignfolderReorderV2Request ezsignfolderReorderV2Request = new EzsignfolderReorderV2Request(); // EzsignfolderReorderV2Request |
try {
EzsignfolderReorderV2Response result = apiInstance.ezsignfolderReorderV2(pkiEzsignfolderID, ezsignfolderReorderV2Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderReorderV2");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| ezsignfolderReorderV2Request | EzsignfolderReorderV2Request |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderSendV1Response ezsignfolderSendV1(pkiEzsignfolderID, ezsignfolderSendV1Request)
Send the Ezsignfolder to the signatories for signature
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
EzsignfolderSendV1Request ezsignfolderSendV1Request = new EzsignfolderSendV1Request(); // EzsignfolderSendV1Request |
try {
EzsignfolderSendV1Response result = apiInstance.ezsignfolderSendV1(pkiEzsignfolderID, ezsignfolderSendV1Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderSendV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| ezsignfolderSendV1Request | EzsignfolderSendV1Request |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderSendV3Response ezsignfolderSendV3(pkiEzsignfolderID, ezsignfolderSendV3Request)
Send the Ezsignfolder to the signatories for signature
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
EzsignfolderSendV3Request ezsignfolderSendV3Request = new EzsignfolderSendV3Request(); // EzsignfolderSendV3Request |
try {
EzsignfolderSendV3Response result = apiInstance.ezsignfolderSendV3(pkiEzsignfolderID, ezsignfolderSendV3Request);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderSendV3");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| ezsignfolderSendV3Request | EzsignfolderSendV3Request |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
EzsignfolderUnsendV1Response ezsignfolderUnsendV1(pkiEzsignfolderID, body)
Unsend the Ezsignfolder
Once an Ezsignfolder has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsignfolder and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign.
// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectEzsignfolderApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
// Configure API key authorization: Authorization
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
Authorization.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Authorization.setApiKeyPrefix("Token");
ObjectEzsignfolderApi apiInstance = new ObjectEzsignfolderApi(defaultClient);
Integer pkiEzsignfolderID = 56; // Integer |
Object body = null; // Object |
try {
EzsignfolderUnsendV1Response result = apiInstance.ezsignfolderUnsendV1(pkiEzsignfolderID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObjectEzsignfolderApi#ezsignfolderUnsendV1");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| pkiEzsignfolderID | Integer | ||
| body | Object |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful response | - |
| 404 | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
| 422 | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |