Skip to content

Latest commit

 

History

History
1564 lines (1129 loc) · 56.3 KB

ObjectEzsigndocumentApi.md

File metadata and controls

1564 lines (1129 loc) · 56.3 KB
Raw

ObjectEzsigndocumentApi

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

Method HTTP request Description
ezsigndocumentApplyEzsigntemplateV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate Apply an Ezsigntemplate to the Ezsigndocument.
ezsigndocumentApplyEzsigntemplateV2 POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate Apply an Ezsigntemplate to the Ezsigndocument.
ezsigndocumentApplyEzsigntemplateglobalV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplateglobal Apply an Ezsigntemplateglobal to the Ezsigndocument.
ezsigndocumentCreateEzsignelementsPositionedByWordV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord Create multiple Ezsignsignatures/Ezsignformfieldgroups
ezsigndocumentCreateObjectV1 POST /1/object/ezsigndocument Create a new Ezsigndocument
ezsigndocumentCreateObjectV2 POST /2/object/ezsigndocument Create a new Ezsigndocument
ezsigndocumentDeclineToSignV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign Decline to sign
ezsigndocumentDeleteObjectV1 DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID} Delete an existing Ezsigndocument
ezsigndocumentEditEzsignformfieldgroupsV1 PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups Edit multiple Ezsignformfieldgroups
ezsigndocumentEditEzsignsignaturesV1 PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures Edit multiple Ezsignsignatures
ezsigndocumentEndPrematurelyV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely End prematurely
ezsigndocumentFlattenV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten Flatten
ezsigndocumentGetActionableElementsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements Retrieve actionable elements for the Ezsigndocument
ezsigndocumentGetAttachmentsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getAttachments Retrieve Ezsigndocument's Attachments
ezsigndocumentGetCompletedElementsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements Retrieve completed elements for the Ezsigndocument
ezsigndocumentGetDownloadUrlV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} Retrieve a URL to download documents.
ezsigndocumentGetEzsignannotationsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations Retrieve an existing Ezsigndocument's Ezsignannotations
ezsigndocumentGetEzsigndiscussionsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsigndiscussions Retrieve an existing Ezsigndocument's Ezsigndiscussions
ezsigndocumentGetEzsignformfieldgroupsV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups Retrieve an existing Ezsigndocument's Ezsignformfieldgroups
ezsigndocumentGetEzsignpagesV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages Retrieve an existing Ezsigndocument's Ezsignpages
ezsigndocumentGetEzsignsignaturesAutomaticV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsigndocument's automatic Ezsignsignatures
ezsigndocumentGetEzsignsignaturesV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures Retrieve an existing Ezsigndocument's Ezsignsignatures
ezsigndocumentGetFormDataV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData Retrieve an existing Ezsigndocument's Form Data
ezsigndocumentGetObjectV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
ezsigndocumentGetObjectV2 GET /2/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
ezsigndocumentGetTemporaryProofV1 GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof Retrieve the temporary proof
ezsigndocumentGetWordsPositionsV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigndocument
ezsigndocumentPatchObjectV1 PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID} Patch an existing Ezsigndocument
ezsigndocumentSubmitEzsignformV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform Submit the Ezsignform
ezsigndocumentUnsendV1 POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend Unsend the Ezsigndocument

ezsigndocumentApplyEzsigntemplateV1

EzsigndocumentApplyEzsigntemplateV1Response ezsigndocumentApplyEzsigntemplateV1(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateV1Request)

Apply an Ezsigntemplate to the Ezsigndocument.

This function is deprecated. Please use applyEzsigntemplate instead which is doing the same thing but with a capital "E" to normalize the nomenclature. This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigndocumentApplyEzsigntemplateV1Request : EzsigndocumentApplyEzsigntemplateV1Request =  // EzsigndocumentApplyEzsigntemplateV1Request | 
try {
    val result : EzsigndocumentApplyEzsigntemplateV1Response = apiInstance.ezsigndocumentApplyEzsigntemplateV1(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentApplyEzsigntemplateV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentApplyEzsigntemplateV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
ezsigndocumentApplyEzsigntemplateV1Request EzsigndocumentApplyEzsigntemplateV1Request

Return type

EzsigndocumentApplyEzsigntemplateV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentApplyEzsigntemplateV2

EzsigndocumentApplyEzsigntemplateV2Response ezsigndocumentApplyEzsigntemplateV2(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateV2Request)

Apply an Ezsigntemplate to the Ezsigndocument.

This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigndocumentApplyEzsigntemplateV2Request : EzsigndocumentApplyEzsigntemplateV2Request =  // EzsigndocumentApplyEzsigntemplateV2Request | 
try {
    val result : EzsigndocumentApplyEzsigntemplateV2Response = apiInstance.ezsigndocumentApplyEzsigntemplateV2(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateV2Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentApplyEzsigntemplateV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentApplyEzsigntemplateV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
ezsigndocumentApplyEzsigntemplateV2Request EzsigndocumentApplyEzsigntemplateV2Request

Return type

EzsigndocumentApplyEzsigntemplateV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentApplyEzsigntemplateglobalV1

EzsigndocumentApplyEzsigntemplateglobalV1Response ezsigndocumentApplyEzsigntemplateglobalV1(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateglobalV1Request)

Apply an Ezsigntemplateglobal to the Ezsigndocument.

This endpoint applies a predefined template to the ezsign document. This allows to automatically apply all the form and signature fields on a document in a single step. The document must not already have fields otherwise an error will be returned.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigndocumentApplyEzsigntemplateglobalV1Request : EzsigndocumentApplyEzsigntemplateglobalV1Request =  // EzsigndocumentApplyEzsigntemplateglobalV1Request | 
try {
    val result : EzsigndocumentApplyEzsigntemplateglobalV1Response = apiInstance.ezsigndocumentApplyEzsigntemplateglobalV1(pkiEzsigndocumentID, ezsigndocumentApplyEzsigntemplateglobalV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentApplyEzsigntemplateglobalV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentApplyEzsigntemplateglobalV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
ezsigndocumentApplyEzsigntemplateglobalV1Request EzsigndocumentApplyEzsigntemplateglobalV1Request

Return type

EzsigndocumentApplyEzsigntemplateglobalV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentCreateEzsignelementsPositionedByWordV1

EzsigndocumentCreateEzsignelementsPositionedByWordV1Response ezsigndocumentCreateEzsignelementsPositionedByWordV1(pkiEzsigndocumentID, ezsigndocumentCreateEzsignelementsPositionedByWordV1Request)

Create multiple Ezsignsignatures/Ezsignformfieldgroups

Using this endpoint, you can create multiple Ezsignsignatures/Ezsignformfieldgroups positioned by word at the same time.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigndocumentCreateEzsignelementsPositionedByWordV1Request : EzsigndocumentCreateEzsignelementsPositionedByWordV1Request =  // EzsigndocumentCreateEzsignelementsPositionedByWordV1Request | 
try {
    val result : EzsigndocumentCreateEzsignelementsPositionedByWordV1Response = apiInstance.ezsigndocumentCreateEzsignelementsPositionedByWordV1(pkiEzsigndocumentID, ezsigndocumentCreateEzsignelementsPositionedByWordV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentCreateEzsignelementsPositionedByWordV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentCreateEzsignelementsPositionedByWordV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
ezsigndocumentCreateEzsignelementsPositionedByWordV1Request EzsigndocumentCreateEzsignelementsPositionedByWordV1Request

Return type

EzsigndocumentCreateEzsignelementsPositionedByWordV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentCreateObjectV1

EzsigndocumentCreateObjectV1Response ezsigndocumentCreateObjectV1(ezsigndocumentCreateObjectV1Request)

Create a new Ezsigndocument

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.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val ezsigndocumentCreateObjectV1Request : kotlin.collections.List<EzsigndocumentCreateObjectV1Request> =  // kotlin.collections.List<EzsigndocumentCreateObjectV1Request> | 
try {
    val result : EzsigndocumentCreateObjectV1Response = apiInstance.ezsigndocumentCreateObjectV1(ezsigndocumentCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsigndocumentCreateObjectV1Request kotlin.collections.List<EzsigndocumentCreateObjectV1Request>

Return type

EzsigndocumentCreateObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentCreateObjectV2

EzsigndocumentCreateObjectV2Response ezsigndocumentCreateObjectV2(ezsigndocumentCreateObjectV2Request)

Create a new Ezsigndocument

The endpoint allows to create one or many elements at once.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val ezsigndocumentCreateObjectV2Request : EzsigndocumentCreateObjectV2Request =  // EzsigndocumentCreateObjectV2Request | 
try {
    val result : EzsigndocumentCreateObjectV2Response = apiInstance.ezsigndocumentCreateObjectV2(ezsigndocumentCreateObjectV2Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentCreateObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentCreateObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsigndocumentCreateObjectV2Request EzsigndocumentCreateObjectV2Request

Return type

EzsigndocumentCreateObjectV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentDeclineToSignV1

EzsigndocumentDeclineToSignV1Response ezsigndocumentDeclineToSignV1(pkiEzsigndocumentID, ezsigndocumentDeclineToSignV1Request)

Decline to sign

Decline to sign

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigndocumentDeclineToSignV1Request : EzsigndocumentDeclineToSignV1Request =  // EzsigndocumentDeclineToSignV1Request | 
try {
    val result : EzsigndocumentDeclineToSignV1Response = apiInstance.ezsigndocumentDeclineToSignV1(pkiEzsigndocumentID, ezsigndocumentDeclineToSignV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentDeclineToSignV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentDeclineToSignV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
ezsigndocumentDeclineToSignV1Request EzsigndocumentDeclineToSignV1Request

Return type

EzsigndocumentDeclineToSignV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentDeleteObjectV1

EzsigndocumentDeleteObjectV1Response ezsigndocumentDeleteObjectV1(pkiEzsigndocumentID)

Delete an existing Ezsigndocument

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentDeleteObjectV1Response = apiInstance.ezsigndocumentDeleteObjectV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentDeleteObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentDeleteObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentDeleteObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentEditEzsignformfieldgroupsV1

EzsigndocumentEditEzsignformfieldgroupsV1Response ezsigndocumentEditEzsignformfieldgroupsV1(pkiEzsigndocumentID, ezsigndocumentEditEzsignformfieldgroupsV1Request)

Edit multiple Ezsignformfieldgroups

Using this endpoint, you can edit multiple Ezsignformfieldgroups at the same time.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigndocumentEditEzsignformfieldgroupsV1Request : EzsigndocumentEditEzsignformfieldgroupsV1Request =  // EzsigndocumentEditEzsignformfieldgroupsV1Request | 
try {
    val result : EzsigndocumentEditEzsignformfieldgroupsV1Response = apiInstance.ezsigndocumentEditEzsignformfieldgroupsV1(pkiEzsigndocumentID, ezsigndocumentEditEzsignformfieldgroupsV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentEditEzsignformfieldgroupsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentEditEzsignformfieldgroupsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
ezsigndocumentEditEzsignformfieldgroupsV1Request EzsigndocumentEditEzsignformfieldgroupsV1Request

Return type

EzsigndocumentEditEzsignformfieldgroupsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentEditEzsignsignaturesV1

EzsigndocumentEditEzsignsignaturesV1Response ezsigndocumentEditEzsignsignaturesV1(pkiEzsigndocumentID, ezsigndocumentEditEzsignsignaturesV1Request)

Edit multiple Ezsignsignatures

Using this endpoint, you can edit multiple Ezsignsignatures at the same time.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigndocumentEditEzsignsignaturesV1Request : EzsigndocumentEditEzsignsignaturesV1Request =  // EzsigndocumentEditEzsignsignaturesV1Request | 
try {
    val result : EzsigndocumentEditEzsignsignaturesV1Response = apiInstance.ezsigndocumentEditEzsignsignaturesV1(pkiEzsigndocumentID, ezsigndocumentEditEzsignsignaturesV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentEditEzsignsignaturesV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentEditEzsignsignaturesV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
ezsigndocumentEditEzsignsignaturesV1Request EzsigndocumentEditEzsignsignaturesV1Request

Return type

EzsigndocumentEditEzsignsignaturesV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentEndPrematurelyV1

EzsigndocumentEndPrematurelyV1Response ezsigndocumentEndPrematurelyV1(pkiEzsigndocumentID, body)

End prematurely

End prematurely an Ezsigndocument when some signatures are still required

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val body : kotlin.Any = Object // kotlin.Any | 
try {
    val result : EzsigndocumentEndPrematurelyV1Response = apiInstance.ezsigndocumentEndPrematurelyV1(pkiEzsigndocumentID, body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentEndPrematurelyV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentEndPrematurelyV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
body kotlin.Any

Return type

EzsigndocumentEndPrematurelyV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentFlattenV1

EzsigndocumentFlattenV1Response ezsigndocumentFlattenV1(pkiEzsigndocumentID, body)

Flatten

Flatten an Ezsigndocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val body : kotlin.Any = Object // kotlin.Any | 
try {
    val result : EzsigndocumentFlattenV1Response = apiInstance.ezsigndocumentFlattenV1(pkiEzsigndocumentID, body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentFlattenV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentFlattenV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
body kotlin.Any

Return type

EzsigndocumentFlattenV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetActionableElementsV1

EzsigndocumentGetActionableElementsV1Response ezsigndocumentGetActionableElementsV1(pkiEzsigndocumentID)

Retrieve actionable elements for the Ezsigndocument

Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetActionableElementsV1Response = apiInstance.ezsigndocumentGetActionableElementsV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetActionableElementsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetActionableElementsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetActionableElementsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetAttachmentsV1

EzsigndocumentGetAttachmentsV1Response ezsigndocumentGetAttachmentsV1(pkiEzsigndocumentID)

Retrieve Ezsigndocument's Attachments

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetAttachmentsV1Response = apiInstance.ezsigndocumentGetAttachmentsV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetAttachmentsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetAttachmentsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetAttachmentsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetCompletedElementsV1

EzsigndocumentGetCompletedElementsV1Response ezsigndocumentGetCompletedElementsV1(pkiEzsigndocumentID)

Retrieve completed elements for the Ezsigndocument

Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotations at the current step in the process

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetCompletedElementsV1Response = apiInstance.ezsigndocumentGetCompletedElementsV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetCompletedElementsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetCompletedElementsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetCompletedElementsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetDownloadUrlV1

EzsigndocumentGetDownloadUrlV1Response ezsigndocumentGetDownloadUrlV1(pkiEzsigndocumentID, eDocumentType)

Retrieve a URL to download documents.

This endpoint returns URLs to different files that can be downloaded during the signing process. These links will expire after 5 minutes so the download of the file should be made soon after retrieving the link.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val eDocumentType : kotlin.String = eDocumentType_example // kotlin.String | The type of document to retrieve.  1. **Initial** Is the initial document before any signature were applied. 2. **SignatureReady** Is the version containing the annotations/form to show the signer. 3. **Signed** Is the final document once all signatures were applied in current document if eEzsignfolderCompletion is PerEzsigndocument.<br>     Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. 
try {
    val result : EzsigndocumentGetDownloadUrlV1Response = apiInstance.ezsigndocumentGetDownloadUrlV1(pkiEzsigndocumentID, eDocumentType)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetDownloadUrlV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetDownloadUrlV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
eDocumentType kotlin.String The type of document to retrieve. 1. Initial Is the initial document before any signature were applied. 2. SignatureReady Is the version containing the annotations/form to show the signer. 3. Signed Is the final document once all signatures were applied in current document if eEzsignfolderCompletion is PerEzsigndocument.<br> Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 4. Proofdocument Is the evidence report. 5. Proof Is the complete evidence archive including all of the above and more. [enum: Initial, SignatureReady, Signed, Proof, Proofdocument]

Return type

EzsigndocumentGetDownloadUrlV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetEzsignannotationsV1

EzsigndocumentGetEzsignannotationsV1Response ezsigndocumentGetEzsignannotationsV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Ezsignannotations

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetEzsignannotationsV1Response = apiInstance.ezsigndocumentGetEzsignannotationsV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignannotationsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignannotationsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetEzsignannotationsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetEzsigndiscussionsV1

EzsigndocumentGetEzsigndiscussionsV1Response ezsigndocumentGetEzsigndiscussionsV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Ezsigndiscussions

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetEzsigndiscussionsV1Response = apiInstance.ezsigndocumentGetEzsigndiscussionsV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsigndiscussionsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsigndiscussionsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetEzsigndiscussionsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetEzsignformfieldgroupsV1

EzsigndocumentGetEzsignformfieldgroupsV1Response ezsigndocumentGetEzsignformfieldgroupsV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Ezsignformfieldgroups

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetEzsignformfieldgroupsV1Response = apiInstance.ezsigndocumentGetEzsignformfieldgroupsV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignformfieldgroupsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignformfieldgroupsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetEzsignformfieldgroupsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetEzsignpagesV1

EzsigndocumentGetEzsignpagesV1Response ezsigndocumentGetEzsignpagesV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Ezsignpages

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetEzsignpagesV1Response = apiInstance.ezsigndocumentGetEzsignpagesV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignpagesV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignpagesV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetEzsignpagesV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetEzsignsignaturesAutomaticV1

EzsigndocumentGetEzsignsignaturesAutomaticV1Response ezsigndocumentGetEzsignsignaturesAutomaticV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's automatic Ezsignsignatures

Return the Ezsignsignatures that can be signed by the current user at the current step in the process

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetEzsignsignaturesAutomaticV1Response = apiInstance.ezsigndocumentGetEzsignsignaturesAutomaticV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignsignaturesAutomaticV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignsignaturesAutomaticV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetEzsignsignaturesAutomaticV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetEzsignsignaturesV1

EzsigndocumentGetEzsignsignaturesV1Response ezsigndocumentGetEzsignsignaturesV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Ezsignsignatures

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetEzsignsignaturesV1Response = apiInstance.ezsigndocumentGetEzsignsignaturesV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignsignaturesV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetEzsignsignaturesV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetEzsignsignaturesV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetFormDataV1

EzsigndocumentGetFormDataV1Response ezsigndocumentGetFormDataV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument's Form Data

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetFormDataV1Response = apiInstance.ezsigndocumentGetFormDataV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetFormDataV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetFormDataV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetFormDataV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetObjectV1

EzsigndocumentGetObjectV1Response ezsigndocumentGetObjectV1(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetObjectV1Response = apiInstance.ezsigndocumentGetObjectV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetObjectV2

EzsigndocumentGetObjectV2Response ezsigndocumentGetObjectV2(pkiEzsigndocumentID)

Retrieve an existing Ezsigndocument

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetObjectV2Response = apiInstance.ezsigndocumentGetObjectV2(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetObjectV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetTemporaryProofV1

EzsigndocumentGetTemporaryProofV1Response ezsigndocumentGetTemporaryProofV1(pkiEzsigndocumentID)

Retrieve the temporary proof

Retrieve the temporary proof while the Ezsigndocument is being processed since the proof isn't available until the Ezsigndocument is completed

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigndocumentGetTemporaryProofV1Response = apiInstance.ezsigndocumentGetTemporaryProofV1(pkiEzsigndocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetTemporaryProofV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetTemporaryProofV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int

Return type

EzsigndocumentGetTemporaryProofV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentGetWordsPositionsV1

EzsigndocumentGetWordsPositionsV1Response ezsigndocumentGetWordsPositionsV1(pkiEzsigndocumentID, ezsigndocumentGetWordsPositionsV1Request)

Retrieve positions X,Y of given words from a Ezsigndocument

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigndocumentGetWordsPositionsV1Request : EzsigndocumentGetWordsPositionsV1Request =  // EzsigndocumentGetWordsPositionsV1Request | 
try {
    val result : EzsigndocumentGetWordsPositionsV1Response = apiInstance.ezsigndocumentGetWordsPositionsV1(pkiEzsigndocumentID, ezsigndocumentGetWordsPositionsV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetWordsPositionsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentGetWordsPositionsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
ezsigndocumentGetWordsPositionsV1Request EzsigndocumentGetWordsPositionsV1Request

Return type

EzsigndocumentGetWordsPositionsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentPatchObjectV1

EzsigndocumentPatchObjectV1Response ezsigndocumentPatchObjectV1(pkiEzsigndocumentID, ezsigndocumentPatchObjectV1Request)

Patch an existing Ezsigndocument

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigndocumentPatchObjectV1Request : EzsigndocumentPatchObjectV1Request =  // EzsigndocumentPatchObjectV1Request | 
try {
    val result : EzsigndocumentPatchObjectV1Response = apiInstance.ezsigndocumentPatchObjectV1(pkiEzsigndocumentID, ezsigndocumentPatchObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentPatchObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentPatchObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
ezsigndocumentPatchObjectV1Request EzsigndocumentPatchObjectV1Request

Return type

EzsigndocumentPatchObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentSubmitEzsignformV1

EzsigndocumentSubmitEzsignformV1Response ezsigndocumentSubmitEzsignformV1(pkiEzsigndocumentID, ezsigndocumentSubmitEzsignformV1Request)

Submit the Ezsignform

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigndocumentSubmitEzsignformV1Request : EzsigndocumentSubmitEzsignformV1Request =  // EzsigndocumentSubmitEzsignformV1Request | 
try {
    val result : EzsigndocumentSubmitEzsignformV1Response = apiInstance.ezsigndocumentSubmitEzsignformV1(pkiEzsigndocumentID, ezsigndocumentSubmitEzsignformV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentSubmitEzsignformV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentSubmitEzsignformV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
ezsigndocumentSubmitEzsignformV1Request EzsigndocumentSubmitEzsignformV1Request

Return type

EzsigndocumentSubmitEzsignformV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

ezsigndocumentUnsendV1

EzsigndocumentUnsendV1Response ezsigndocumentUnsendV1(pkiEzsigndocumentID, body)

Unsend the Ezsigndocument

Once an Ezsigndocument has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsigndocument 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. ⚠️ Warning: Any signature previously made by signatories on this Ezsigndocumentswill be lost.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectEzsigndocumentApi()
val pkiEzsigndocumentID : kotlin.Int = 56 // kotlin.Int | 
val body : kotlin.Any = Object // kotlin.Any | 
try {
    val result : EzsigndocumentUnsendV1Response = apiInstance.ezsigndocumentUnsendV1(pkiEzsigndocumentID, body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigndocumentApi#ezsigndocumentUnsendV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigndocumentApi#ezsigndocumentUnsendV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigndocumentID kotlin.Int
body kotlin.Any

Return type

EzsigndocumentUnsendV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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