Skip to content

Latest commit

 

History

History
1509 lines (1086 loc) · 50.5 KB

ObjectEzsignfolderApi.md

File metadata and controls

1509 lines (1086 loc) · 50.5 KB
Raw

ObjectEzsignfolderApi

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
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
ezsignfolderEditObjectV1 PUT /1/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
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
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
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.
ezsignfolderReorderV1 POST /1/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

ezsignfolderArchiveV1

EzsignfolderArchiveV1Response ezsignfolderArchiveV1(pkiEzsignfolderID, body)

Archive the Ezsignfolder

Example

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

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

Parameters

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

Return type

EzsignfolderArchiveV1Response

Authorization

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

HTTP request headers

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

ezsignfolderBatchDownloadV1

java.io.File ezsignfolderBatchDownloadV1(pkiEzsignfolderID, ezsignfolderBatchDownloadV1Request)

Download multiples files from an Ezsignfolder

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
val ezsignfolderBatchDownloadV1Request : EzsignfolderBatchDownloadV1Request =  // EzsignfolderBatchDownloadV1Request | 
try {
    val result : java.io.File = apiInstance.ezsignfolderBatchDownloadV1(pkiEzsignfolderID, ezsignfolderBatchDownloadV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderBatchDownloadV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderBatchDownloadV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int
ezsignfolderBatchDownloadV1Request EzsignfolderBatchDownloadV1Request

Return type

java.io.File

Authorization

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

HTTP request headers

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

ezsignfolderCreateObjectV1

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.

Example

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

val apiInstance = ObjectEzsignfolderApi()
val ezsignfolderCreateObjectV1Request : kotlin.collections.List<EzsignfolderCreateObjectV1Request> =  // kotlin.collections.List<EzsignfolderCreateObjectV1Request> | 
try {
    val result : EzsignfolderCreateObjectV1Response = apiInstance.ezsignfolderCreateObjectV1(ezsignfolderCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsignfolderCreateObjectV1Request kotlin.collections.List<EzsignfolderCreateObjectV1Request>

Return type

EzsignfolderCreateObjectV1Response

Authorization

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

HTTP request headers

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

ezsignfolderCreateObjectV2

EzsignfolderCreateObjectV2Response ezsignfolderCreateObjectV2(ezsignfolderCreateObjectV2Request)

Create a new Ezsignfolder

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

Example

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

val apiInstance = ObjectEzsignfolderApi()
val ezsignfolderCreateObjectV2Request : EzsignfolderCreateObjectV2Request =  // EzsignfolderCreateObjectV2Request | 
try {
    val result : EzsignfolderCreateObjectV2Response = apiInstance.ezsignfolderCreateObjectV2(ezsignfolderCreateObjectV2Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderCreateObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderCreateObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsignfolderCreateObjectV2Request EzsignfolderCreateObjectV2Request

Return type

EzsignfolderCreateObjectV2Response

Authorization

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

HTTP request headers

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

ezsignfolderDeleteObjectV1

EzsignfolderDeleteObjectV1Response ezsignfolderDeleteObjectV1(pkiEzsignfolderID)

Delete an existing Ezsignfolder

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderDeleteObjectV1Response = apiInstance.ezsignfolderDeleteObjectV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderDeleteObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderDeleteObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderDeleteObjectV1Response

Authorization

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

HTTP request headers

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

ezsignfolderDisposeEzsignfoldersV1

EzsignfolderDisposeEzsignfoldersV1Response ezsignfolderDisposeEzsignfoldersV1(ezsignfolderDisposeEzsignfoldersV1Request)

Dispose Ezsignfolders

Example

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

val apiInstance = ObjectEzsignfolderApi()
val ezsignfolderDisposeEzsignfoldersV1Request : EzsignfolderDisposeEzsignfoldersV1Request =  // EzsignfolderDisposeEzsignfoldersV1Request | 
try {
    val result : EzsignfolderDisposeEzsignfoldersV1Response = apiInstance.ezsignfolderDisposeEzsignfoldersV1(ezsignfolderDisposeEzsignfoldersV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderDisposeEzsignfoldersV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderDisposeEzsignfoldersV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsignfolderDisposeEzsignfoldersV1Request EzsignfolderDisposeEzsignfoldersV1Request

Return type

EzsignfolderDisposeEzsignfoldersV1Response

Authorization

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

HTTP request headers

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

ezsignfolderDisposeV1

EzsignfolderDisposeV1Response ezsignfolderDisposeV1(pkiEzsignfolderID, body)

Dispose the Ezsignfolder

Example

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

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

Parameters

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

Return type

EzsignfolderDisposeV1Response

Authorization

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

HTTP request headers

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

ezsignfolderEditObjectV1

EzsignfolderEditObjectV1Response ezsignfolderEditObjectV1(pkiEzsignfolderID, ezsignfolderEditObjectV1Request)

Edit an existing Ezsignfolder

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
val ezsignfolderEditObjectV1Request : EzsignfolderEditObjectV1Request =  // EzsignfolderEditObjectV1Request | 
try {
    val result : EzsignfolderEditObjectV1Response = apiInstance.ezsignfolderEditObjectV1(pkiEzsignfolderID, ezsignfolderEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderEditObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int
ezsignfolderEditObjectV1Request EzsignfolderEditObjectV1Request

Return type

EzsignfolderEditObjectV1Response

Authorization

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

HTTP request headers

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

ezsignfolderEndPrematurelyV1

EzsignfolderEndPrematurelyV1Response ezsignfolderEndPrematurelyV1(pkiEzsignfolderID, body)

End prematurely

End prematurely all Ezsigndocument of Ezsignfolder when some signatures are still required

Example

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

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

Parameters

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

Return type

EzsignfolderEndPrematurelyV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetActionableElementsV1

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

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetActionableElementsV1Response = apiInstance.ezsignfolderGetActionableElementsV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetActionableElementsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetActionableElementsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetActionableElementsV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetAttachmentCountV1

EzsignfolderGetAttachmentCountV1Response ezsignfolderGetAttachmentCountV1(pkiEzsignfolderID)

Retrieve Attachment count

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetAttachmentCountV1Response = apiInstance.ezsignfolderGetAttachmentCountV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetAttachmentCountV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetAttachmentCountV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetAttachmentCountV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetAttachmentsV1

EzsignfolderGetAttachmentsV1Response ezsignfolderGetAttachmentsV1(pkiEzsignfolderID)

Retrieve Ezsignfolder's Attachments

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetAttachmentsV1Response = apiInstance.ezsignfolderGetAttachmentsV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetAttachmentsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetAttachmentsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetAttachmentsV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetCommunicationCountV1

EzsignfolderGetCommunicationCountV1Response ezsignfolderGetCommunicationCountV1(pkiEzsignfolderID)

Retrieve Communication count

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetCommunicationCountV1Response = apiInstance.ezsignfolderGetCommunicationCountV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationCountV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationCountV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetCommunicationCountV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetCommunicationListV1

EzsignfolderGetCommunicationListV1Response ezsignfolderGetCommunicationListV1(pkiEzsignfolderID)

Retrieve Communication list

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetCommunicationListV1Response = apiInstance.ezsignfolderGetCommunicationListV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationListV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationListV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetCommunicationListV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetCommunicationrecipientsV1

EzsignfolderGetCommunicationrecipientsV1Response ezsignfolderGetCommunicationrecipientsV1(pkiEzsignfolderID)

Retrieve Ezsignfolder's Communicationrecipient

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetCommunicationrecipientsV1Response = apiInstance.ezsignfolderGetCommunicationrecipientsV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationrecipientsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationrecipientsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetCommunicationrecipientsV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetCommunicationsendersV1

EzsignfolderGetCommunicationsendersV1Response ezsignfolderGetCommunicationsendersV1(pkiEzsignfolderID)

Retrieve Ezsignfolder's Communicationsender

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetCommunicationsendersV1Response = apiInstance.ezsignfolderGetCommunicationsendersV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationsendersV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetCommunicationsendersV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetCommunicationsendersV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetEzsigndocumentsV1

EzsignfolderGetEzsigndocumentsV1Response ezsignfolderGetEzsigndocumentsV1(pkiEzsignfolderID)

Retrieve an existing Ezsignfolder's Ezsigndocuments

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetEzsigndocumentsV1Response = apiInstance.ezsignfolderGetEzsigndocumentsV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetEzsigndocumentsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetEzsigndocumentsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetEzsigndocumentsV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetEzsignfoldersignerassociationsV1

EzsignfolderGetEzsignfoldersignerassociationsV1Response ezsignfolderGetEzsignfoldersignerassociationsV1(pkiEzsignfolderID)

Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetEzsignfoldersignerassociationsV1Response = apiInstance.ezsignfolderGetEzsignfoldersignerassociationsV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetEzsignfoldersignerassociationsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetEzsignfoldersignerassociationsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetEzsignfoldersignerassociationsV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetEzsignsignaturesAutomaticV1

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

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetEzsignsignaturesAutomaticV1Response = apiInstance.ezsignfolderGetEzsignsignaturesAutomaticV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetEzsignsignaturesAutomaticV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetEzsignsignaturesAutomaticV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetEzsignsignaturesAutomaticV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetFormsDataV1

EzsignfolderGetFormsDataV1Response ezsignfolderGetFormsDataV1(pkiEzsignfolderID)

Retrieve an existing Ezsignfolder's forms data

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetFormsDataV1Response = apiInstance.ezsignfolderGetFormsDataV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetFormsDataV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetFormsDataV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetFormsDataV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetListV1

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

Example

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

val apiInstance = ObjectEzsignfolderApi()
val eOrderBy : kotlin.String = eOrderBy_example // kotlin.String | Specify how you want the results to be sorted
val iRowMax : kotlin.Int = 56 // kotlin.Int | 
val iRowOffset : kotlin.Int = 56 // kotlin.Int | 
val acceptLanguage : HeaderAcceptLanguage =  // HeaderAcceptLanguage | 
val sFilter : kotlin.String = sFilter_example // kotlin.String | 
try {
    val result : EzsignfolderGetListV1Response = apiInstance.ezsignfolderGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetListV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetListV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
eOrderBy kotlin.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, 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]
iRowMax kotlin.Int [optional]
iRowOffset kotlin.Int [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional] [enum: *, en, fr]
sFilter kotlin.String [optional]

Return type

EzsignfolderGetListV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetObjectV1

EzsignfolderGetObjectV1Response ezsignfolderGetObjectV1(pkiEzsignfolderID)

Retrieve an existing Ezsignfolder

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetObjectV1Response = apiInstance.ezsignfolderGetObjectV1(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetObjectV1Response

Authorization

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

HTTP request headers

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

ezsignfolderGetObjectV2

EzsignfolderGetObjectV2Response ezsignfolderGetObjectV2(pkiEzsignfolderID)

Retrieve an existing Ezsignfolder

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignfolderGetObjectV2Response = apiInstance.ezsignfolderGetObjectV2(pkiEzsignfolderID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int

Return type

EzsignfolderGetObjectV2Response

Authorization

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

HTTP request headers

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

ezsignfolderImportEzsignfoldersignerassociationsV1

EzsignfolderImportEzsignfoldersignerassociationsV1Response ezsignfolderImportEzsignfoldersignerassociationsV1(pkiEzsignfolderID, ezsignfolderImportEzsignfoldersignerassociationsV1Request)

Import an existing Ezsignfoldersignerassociation into this Ezsignfolder

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
val ezsignfolderImportEzsignfoldersignerassociationsV1Request : EzsignfolderImportEzsignfoldersignerassociationsV1Request =  // EzsignfolderImportEzsignfoldersignerassociationsV1Request | 
try {
    val result : EzsignfolderImportEzsignfoldersignerassociationsV1Response = apiInstance.ezsignfolderImportEzsignfoldersignerassociationsV1(pkiEzsignfolderID, ezsignfolderImportEzsignfoldersignerassociationsV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderImportEzsignfoldersignerassociationsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderImportEzsignfoldersignerassociationsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int
ezsignfolderImportEzsignfoldersignerassociationsV1Request EzsignfolderImportEzsignfoldersignerassociationsV1Request

Return type

EzsignfolderImportEzsignfoldersignerassociationsV1Response

Authorization

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

HTTP request headers

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

ezsignfolderImportEzsigntemplatepackageV1

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.

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
val ezsignfolderImportEzsigntemplatepackageV1Request : EzsignfolderImportEzsigntemplatepackageV1Request =  // EzsignfolderImportEzsigntemplatepackageV1Request | 
try {
    val result : EzsignfolderImportEzsigntemplatepackageV1Response = apiInstance.ezsignfolderImportEzsigntemplatepackageV1(pkiEzsignfolderID, ezsignfolderImportEzsigntemplatepackageV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderImportEzsigntemplatepackageV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderImportEzsigntemplatepackageV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int
ezsignfolderImportEzsigntemplatepackageV1Request EzsignfolderImportEzsigntemplatepackageV1Request

Return type

EzsignfolderImportEzsigntemplatepackageV1Response

Authorization

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

HTTP request headers

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

ezsignfolderReorderV1

EzsignfolderReorderV1Response ezsignfolderReorderV1(pkiEzsignfolderID, ezsignfolderReorderV1Request)

Reorder Ezsigndocuments in the Ezsignfolder

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
val ezsignfolderReorderV1Request : EzsignfolderReorderV1Request =  // EzsignfolderReorderV1Request | 
try {
    val result : EzsignfolderReorderV1Response = apiInstance.ezsignfolderReorderV1(pkiEzsignfolderID, ezsignfolderReorderV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderReorderV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderReorderV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int
ezsignfolderReorderV1Request EzsignfolderReorderV1Request

Return type

EzsignfolderReorderV1Response

Authorization

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

HTTP request headers

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

ezsignfolderSendV1

EzsignfolderSendV1Response ezsignfolderSendV1(pkiEzsignfolderID, ezsignfolderSendV1Request)

Send the Ezsignfolder to the signatories for signature

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
val ezsignfolderSendV1Request : EzsignfolderSendV1Request =  // EzsignfolderSendV1Request | 
try {
    val result : EzsignfolderSendV1Response = apiInstance.ezsignfolderSendV1(pkiEzsignfolderID, ezsignfolderSendV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderSendV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderSendV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int
ezsignfolderSendV1Request EzsignfolderSendV1Request

Return type

EzsignfolderSendV1Response

Authorization

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

HTTP request headers

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

ezsignfolderSendV3

EzsignfolderSendV3Response ezsignfolderSendV3(pkiEzsignfolderID, ezsignfolderSendV3Request)

Send the Ezsignfolder to the signatories for signature

Example

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

val apiInstance = ObjectEzsignfolderApi()
val pkiEzsignfolderID : kotlin.Int = 56 // kotlin.Int | 
val ezsignfolderSendV3Request : EzsignfolderSendV3Request =  // EzsignfolderSendV3Request | 
try {
    val result : EzsignfolderSendV3Response = apiInstance.ezsignfolderSendV3(pkiEzsignfolderID, ezsignfolderSendV3Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignfolderApi#ezsignfolderSendV3")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignfolderApi#ezsignfolderSendV3")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignfolderID kotlin.Int
ezsignfolderSendV3Request EzsignfolderSendV3Request

Return type

EzsignfolderSendV3Response

Authorization

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

HTTP request headers

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

ezsignfolderUnsendV1

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. ⚠️ Warning: Any signature previously made by signatories on &quot;Non-completed&quot; Ezsigndocuments will be lost.

Example

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

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

Parameters

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

Return type

EzsignfolderUnsendV1Response

Authorization

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

HTTP request headers

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