Skip to content

Latest commit

 

History

History
581 lines (416 loc) · 22.9 KB

ObjectEzsigntemplatedocumentApi.md

File metadata and controls

581 lines (416 loc) · 22.9 KB
Raw

ObjectEzsigntemplatedocumentApi

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

Method HTTP request Description
ezsigntemplatedocumentCreateObjectV1 POST /1/object/ezsigntemplatedocument Create a new Ezsigntemplatedocument
ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups Edit multiple Ezsigntemplateformfieldgroups
ezsigntemplatedocumentEditEzsigntemplatesignaturesV1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures Edit multiple Ezsigntemplatesignatures
ezsigntemplatedocumentEditObjectV1 PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Edit an existing Ezsigntemplatedocument
ezsigntemplatedocumentFlattenV1 POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten Flatten
ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages
ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplateformfieldgroups Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups
ezsigntemplatedocumentGetEzsigntemplatesignaturesV1 GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures
ezsigntemplatedocumentGetObjectV2 GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Retrieve an existing Ezsigntemplatedocument
ezsigntemplatedocumentGetWordsPositionsV1 POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigntemplatedocument
ezsigntemplatedocumentPatchObjectV1 PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID} Patch an existing Ezsigntemplatedocument

ezsigntemplatedocumentCreateObjectV1

EzsigntemplatedocumentCreateObjectV1Response ezsigntemplatedocumentCreateObjectV1(ezsigntemplatedocumentCreateObjectV1Request)

Create a new Ezsigntemplatedocument

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

Example

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

val apiInstance = ObjectEzsigntemplatedocumentApi()
val ezsigntemplatedocumentCreateObjectV1Request : EzsigntemplatedocumentCreateObjectV1Request =  // EzsigntemplatedocumentCreateObjectV1Request | 
try {
    val result : EzsigntemplatedocumentCreateObjectV1Response = apiInstance.ezsigntemplatedocumentCreateObjectV1(ezsigntemplatedocumentCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsigntemplatedocumentCreateObjectV1Request EzsigntemplatedocumentCreateObjectV1Request

Return type

EzsigntemplatedocumentCreateObjectV1Response

Authorization

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

HTTP request headers

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

ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1

EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1(pkiEzsigntemplatedocumentID, ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request)

Edit multiple Ezsigntemplateformfieldgroups

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

Example

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

val apiInstance = ObjectEzsigntemplatedocumentApi()
val pkiEzsigntemplatedocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request : EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request =  // EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request | 
try {
    val result : EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response = apiInstance.ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1(pkiEzsigntemplatedocumentID, ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID kotlin.Int
ezsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Request

Return type

EzsigntemplatedocumentEditEzsigntemplateformfieldgroupsV1Response

Authorization

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

HTTP request headers

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

ezsigntemplatedocumentEditEzsigntemplatesignaturesV1

EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response ezsigntemplatedocumentEditEzsigntemplatesignaturesV1(pkiEzsigntemplatedocumentID, ezsigntemplatedocumentEditEzsigntemplatesignaturesV1Request)

Edit multiple Ezsigntemplatesignatures

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

Example

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

val apiInstance = ObjectEzsigntemplatedocumentApi()
val pkiEzsigntemplatedocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigntemplatedocumentEditEzsigntemplatesignaturesV1Request : EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request =  // EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request | 
try {
    val result : EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response = apiInstance.ezsigntemplatedocumentEditEzsigntemplatesignaturesV1(pkiEzsigntemplatedocumentID, ezsigntemplatedocumentEditEzsigntemplatesignaturesV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentEditEzsigntemplatesignaturesV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentEditEzsigntemplatesignaturesV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID kotlin.Int
ezsigntemplatedocumentEditEzsigntemplatesignaturesV1Request EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Request

Return type

EzsigntemplatedocumentEditEzsigntemplatesignaturesV1Response

Authorization

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

HTTP request headers

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

ezsigntemplatedocumentEditObjectV1

EzsigntemplatedocumentEditObjectV1Response ezsigntemplatedocumentEditObjectV1(pkiEzsigntemplatedocumentID, ezsigntemplatedocumentEditObjectV1Request)

Edit an existing Ezsigntemplatedocument

Example

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

val apiInstance = ObjectEzsigntemplatedocumentApi()
val pkiEzsigntemplatedocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigntemplatedocumentEditObjectV1Request : EzsigntemplatedocumentEditObjectV1Request =  // EzsigntemplatedocumentEditObjectV1Request | 
try {
    val result : EzsigntemplatedocumentEditObjectV1Response = apiInstance.ezsigntemplatedocumentEditObjectV1(pkiEzsigntemplatedocumentID, ezsigntemplatedocumentEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentEditObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID kotlin.Int
ezsigntemplatedocumentEditObjectV1Request EzsigntemplatedocumentEditObjectV1Request

Return type

EzsigntemplatedocumentEditObjectV1Response

Authorization

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

HTTP request headers

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

ezsigntemplatedocumentFlattenV1

EzsigntemplatedocumentFlattenV1Response ezsigntemplatedocumentFlattenV1(pkiEzsigntemplatedocumentID, body)

Flatten

Flatten an Ezsigntemplatedocument 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 = ObjectEzsigntemplatedocumentApi()
val pkiEzsigntemplatedocumentID : kotlin.Int = 56 // kotlin.Int | 
val body : kotlin.Any = Object // kotlin.Any | 
try {
    val result : EzsigntemplatedocumentFlattenV1Response = apiInstance.ezsigntemplatedocumentFlattenV1(pkiEzsigntemplatedocumentID, body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentFlattenV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentFlattenV1")
    e.printStackTrace()
}

Parameters

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

Return type

EzsigntemplatedocumentFlattenV1Response

Authorization

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

HTTP request headers

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

ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1

EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1(pkiEzsigntemplatedocumentID)

Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages

Example

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

val apiInstance = ObjectEzsigntemplatedocumentApi()
val pkiEzsigntemplatedocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response = apiInstance.ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1(pkiEzsigntemplatedocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentGetEzsigntemplatedocumentpagesV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID kotlin.Int

Return type

EzsigntemplatedocumentGetEzsigntemplatedocumentpagesV1Response

Authorization

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

HTTP request headers

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

ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1

EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1(pkiEzsigntemplatedocumentID)

Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups

Example

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

val apiInstance = ObjectEzsigntemplatedocumentApi()
val pkiEzsigntemplatedocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response = apiInstance.ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1(pkiEzsigntemplatedocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID kotlin.Int

Return type

EzsigntemplatedocumentGetEzsigntemplateformfieldgroupsV1Response

Authorization

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

HTTP request headers

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

ezsigntemplatedocumentGetEzsigntemplatesignaturesV1

EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response ezsigntemplatedocumentGetEzsigntemplatesignaturesV1(pkiEzsigntemplatedocumentID)

Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures

Example

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

val apiInstance = ObjectEzsigntemplatedocumentApi()
val pkiEzsigntemplatedocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response = apiInstance.ezsigntemplatedocumentGetEzsigntemplatesignaturesV1(pkiEzsigntemplatedocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentGetEzsigntemplatesignaturesV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentGetEzsigntemplatesignaturesV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID kotlin.Int

Return type

EzsigntemplatedocumentGetEzsigntemplatesignaturesV1Response

Authorization

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

HTTP request headers

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

ezsigntemplatedocumentGetObjectV2

EzsigntemplatedocumentGetObjectV2Response ezsigntemplatedocumentGetObjectV2(pkiEzsigntemplatedocumentID)

Retrieve an existing Ezsigntemplatedocument

Example

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

val apiInstance = ObjectEzsigntemplatedocumentApi()
val pkiEzsigntemplatedocumentID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsigntemplatedocumentGetObjectV2Response = apiInstance.ezsigntemplatedocumentGetObjectV2(pkiEzsigntemplatedocumentID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID kotlin.Int

Return type

EzsigntemplatedocumentGetObjectV2Response

Authorization

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

HTTP request headers

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

ezsigntemplatedocumentGetWordsPositionsV1

EzsigntemplatedocumentGetWordsPositionsV1Response ezsigntemplatedocumentGetWordsPositionsV1(pkiEzsigntemplatedocumentID, ezsigntemplatedocumentGetWordsPositionsV1Request)

Retrieve positions X,Y of given words from a Ezsigntemplatedocument

Example

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

val apiInstance = ObjectEzsigntemplatedocumentApi()
val pkiEzsigntemplatedocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigntemplatedocumentGetWordsPositionsV1Request : EzsigntemplatedocumentGetWordsPositionsV1Request =  // EzsigntemplatedocumentGetWordsPositionsV1Request | 
try {
    val result : EzsigntemplatedocumentGetWordsPositionsV1Response = apiInstance.ezsigntemplatedocumentGetWordsPositionsV1(pkiEzsigntemplatedocumentID, ezsigntemplatedocumentGetWordsPositionsV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentGetWordsPositionsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentGetWordsPositionsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID kotlin.Int
ezsigntemplatedocumentGetWordsPositionsV1Request EzsigntemplatedocumentGetWordsPositionsV1Request

Return type

EzsigntemplatedocumentGetWordsPositionsV1Response

Authorization

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

HTTP request headers

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

ezsigntemplatedocumentPatchObjectV1

EzsigntemplatedocumentPatchObjectV1Response ezsigntemplatedocumentPatchObjectV1(pkiEzsigntemplatedocumentID, ezsigntemplatedocumentPatchObjectV1Request)

Patch an existing Ezsigntemplatedocument

Example

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

val apiInstance = ObjectEzsigntemplatedocumentApi()
val pkiEzsigntemplatedocumentID : kotlin.Int = 56 // kotlin.Int | 
val ezsigntemplatedocumentPatchObjectV1Request : EzsigntemplatedocumentPatchObjectV1Request =  // EzsigntemplatedocumentPatchObjectV1Request | 
try {
    val result : EzsigntemplatedocumentPatchObjectV1Response = apiInstance.ezsigntemplatedocumentPatchObjectV1(pkiEzsigntemplatedocumentID, ezsigntemplatedocumentPatchObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentPatchObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsigntemplatedocumentApi#ezsigntemplatedocumentPatchObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsigntemplatedocumentID kotlin.Int
ezsigntemplatedocumentPatchObjectV1Request EzsigntemplatedocumentPatchObjectV1Request

Return type

EzsigntemplatedocumentPatchObjectV1Response

Authorization

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

HTTP request headers

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