Skip to content

Latest commit

 

History

History
213 lines (165 loc) · 7.9 KB

ESignatureApi.md

File metadata and controls

213 lines (165 loc) · 7.9 KB
Raw

ESignatureApi

All URIs are relative to http://localhost

Method HTTP request Description
addDocusignEnvelopes POST /esignature/docusign/{documentId}/envelopes Create Docusign Envelope request
addDocusignRecipientView POST /esignature/docusign/{documentId}/envelopes/{envelopeId}/views/recipient Create Docusign Recipient View request
addEsignatureDocusignEvents POST /esignature/docusign/events Add E-signature event

addDocusignEnvelopes

AddDocusignEnvelopesResponse addDocusignEnvelopes(documentId, addDocusignEnvelopesRequest, siteId)

Create Docusign Envelope request

DocuSign create Docusign Envelope request; ONLY available with FormKiQ Enterprise

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.ESignatureApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    ESignatureApi apiInstance = new ESignatureApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    AddDocusignEnvelopesRequest addDocusignEnvelopesRequest = new AddDocusignEnvelopesRequest(); // AddDocusignEnvelopesRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      AddDocusignEnvelopesResponse result = apiInstance.addDocusignEnvelopes(documentId, addDocusignEnvelopesRequest, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ESignatureApi#addDocusignEnvelopes");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
documentId String Document Identifier
addDocusignEnvelopesRequest AddDocusignEnvelopesRequest
siteId String Site Identifier [optional]

Return type

AddDocusignEnvelopesResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 400 OK -

addDocusignRecipientView

AddDocusignRecipientViewResponse addDocusignRecipientView(documentId, envelopeId, addDocusignRecipientViewRequest, siteId)

Create Docusign Recipient View request

DocuSign create Docusign Recipient View request; ONLY available with FormKiQ Enterprise

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.auth.*;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.ESignatureApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    ESignatureApi apiInstance = new ESignatureApi(defaultClient);
    String documentId = "documentId_example"; // String | Document Identifier
    String envelopeId = "envelopeId_example"; // String | Docusign Envelope Id
    AddDocusignRecipientViewRequest addDocusignRecipientViewRequest = new AddDocusignRecipientViewRequest(); // AddDocusignRecipientViewRequest | 
    String siteId = "siteId_example"; // String | Site Identifier
    try {
      AddDocusignRecipientViewResponse result = apiInstance.addDocusignRecipientView(documentId, envelopeId, addDocusignRecipientViewRequest, siteId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ESignatureApi#addDocusignRecipientView");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
documentId String Document Identifier
envelopeId String Docusign Envelope Id
addDocusignRecipientViewRequest AddDocusignRecipientViewRequest
siteId String Site Identifier [optional]

Return type

AddDocusignRecipientViewResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -
400 400 OK -

addEsignatureDocusignEvents

AddResponse addEsignatureDocusignEvents()

Add E-signature event

DocuSign callback URL handler; ONLY available with FormKiQ Enterprise

Example

// Import classes:
import com.formkiq.client.invoker.ApiClient;
import com.formkiq.client.invoker.ApiException;
import com.formkiq.client.invoker.Configuration;
import com.formkiq.client.invoker.models.*;
import com.formkiq.client.api.ESignatureApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")

    ESignatureApi apiInstance = new ESignatureApi(defaultClient);
    try {
      AddResponse result = apiInstance.addEsignatureDocusignEvents();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ESignatureApi#addEsignatureDocusignEvents");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

AddResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 200 OK * Access-Control-Allow-Origin -
* Access-Control-Allow-Methods -
* Access-Control-Allow-Headers -