Skip to content

Latest commit

 

History

History
414 lines (296 loc) · 13.8 KB

ObjectEzsignsignatureApi.md

File metadata and controls

414 lines (296 loc) · 13.8 KB
Raw

ObjectEzsignsignatureApi

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

Method HTTP request Description
ezsignsignatureCreateObjectV1 POST /1/object/ezsignsignature Create a new Ezsignsignature
ezsignsignatureCreateObjectV2 POST /2/object/ezsignsignature Create a new Ezsignsignature
ezsignsignatureDeleteObjectV1 DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} Delete an existing Ezsignsignature
ezsignsignatureEditObjectV1 PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} Edit an existing Ezsignsignature
ezsignsignatureGetEzsignsignatureattachmentV1 GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment Retrieve an existing Ezsignsignature's Ezsignsignatureattachments
ezsignsignatureGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic Retrieve all automatic Ezsignsignatures
ezsignsignatureGetObjectV2 GET /2/object/ezsignsignature/{pkiEzsignsignatureID} Retrieve an existing Ezsignsignature
ezsignsignatureSignV1 POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign Sign the Ezsignsignature

ezsignsignatureCreateObjectV1

EzsignsignatureCreateObjectV1Response ezsignsignatureCreateObjectV1(ezsignsignatureCreateObjectV1Request)

Create a new Ezsignsignature

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 = ObjectEzsignsignatureApi()
val ezsignsignatureCreateObjectV1Request : kotlin.collections.List<EzsignsignatureCreateObjectV1Request> =  // kotlin.collections.List<EzsignsignatureCreateObjectV1Request> | 
try {
    val result : EzsignsignatureCreateObjectV1Response = apiInstance.ezsignsignatureCreateObjectV1(ezsignsignatureCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignsignatureApi#ezsignsignatureCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignsignatureApi#ezsignsignatureCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsignsignatureCreateObjectV1Request kotlin.collections.List<EzsignsignatureCreateObjectV1Request>

Return type

EzsignsignatureCreateObjectV1Response

Authorization

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

HTTP request headers

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

ezsignsignatureCreateObjectV2

EzsignsignatureCreateObjectV2Response ezsignsignatureCreateObjectV2(ezsignsignatureCreateObjectV2Request)

Create a new Ezsignsignature

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

Example

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

val apiInstance = ObjectEzsignsignatureApi()
val ezsignsignatureCreateObjectV2Request : EzsignsignatureCreateObjectV2Request =  // EzsignsignatureCreateObjectV2Request | 
try {
    val result : EzsignsignatureCreateObjectV2Response = apiInstance.ezsignsignatureCreateObjectV2(ezsignsignatureCreateObjectV2Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignsignatureApi#ezsignsignatureCreateObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignsignatureApi#ezsignsignatureCreateObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsignsignatureCreateObjectV2Request EzsignsignatureCreateObjectV2Request

Return type

EzsignsignatureCreateObjectV2Response

Authorization

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

HTTP request headers

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

ezsignsignatureDeleteObjectV1

EzsignsignatureDeleteObjectV1Response ezsignsignatureDeleteObjectV1(pkiEzsignsignatureID)

Delete an existing Ezsignsignature

Example

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

val apiInstance = ObjectEzsignsignatureApi()
val pkiEzsignsignatureID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignsignatureDeleteObjectV1Response = apiInstance.ezsignsignatureDeleteObjectV1(pkiEzsignsignatureID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignsignatureApi#ezsignsignatureDeleteObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignsignatureApi#ezsignsignatureDeleteObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignsignatureID kotlin.Int

Return type

EzsignsignatureDeleteObjectV1Response

Authorization

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

HTTP request headers

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

ezsignsignatureEditObjectV1

EzsignsignatureEditObjectV1Response ezsignsignatureEditObjectV1(pkiEzsignsignatureID, ezsignsignatureEditObjectV1Request)

Edit an existing Ezsignsignature

Example

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

val apiInstance = ObjectEzsignsignatureApi()
val pkiEzsignsignatureID : kotlin.Int = 56 // kotlin.Int | 
val ezsignsignatureEditObjectV1Request : EzsignsignatureEditObjectV1Request =  // EzsignsignatureEditObjectV1Request | 
try {
    val result : EzsignsignatureEditObjectV1Response = apiInstance.ezsignsignatureEditObjectV1(pkiEzsignsignatureID, ezsignsignatureEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignsignatureApi#ezsignsignatureEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignsignatureApi#ezsignsignatureEditObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignsignatureID kotlin.Int
ezsignsignatureEditObjectV1Request EzsignsignatureEditObjectV1Request

Return type

EzsignsignatureEditObjectV1Response

Authorization

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

HTTP request headers

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

ezsignsignatureGetEzsignsignatureattachmentV1

EzsignsignatureGetEzsignsignatureattachmentV1Response ezsignsignatureGetEzsignsignatureattachmentV1(pkiEzsignsignatureID)

Retrieve an existing Ezsignsignature's Ezsignsignatureattachments

Example

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

val apiInstance = ObjectEzsignsignatureApi()
val pkiEzsignsignatureID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignsignatureGetEzsignsignatureattachmentV1Response = apiInstance.ezsignsignatureGetEzsignsignatureattachmentV1(pkiEzsignsignatureID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignsignatureApi#ezsignsignatureGetEzsignsignatureattachmentV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignsignatureApi#ezsignsignatureGetEzsignsignatureattachmentV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignsignatureID kotlin.Int

Return type

EzsignsignatureGetEzsignsignatureattachmentV1Response

Authorization

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

HTTP request headers

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

ezsignsignatureGetEzsignsignaturesAutomaticV1

EzsignsignatureGetEzsignsignaturesAutomaticV1Response ezsignsignatureGetEzsignsignaturesAutomaticV1()

Retrieve all automatic Ezsignsignatures

Return all the Ezsignsignatures that can be signed by the current user

Example

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

val apiInstance = ObjectEzsignsignatureApi()
try {
    val result : EzsignsignatureGetEzsignsignaturesAutomaticV1Response = apiInstance.ezsignsignatureGetEzsignsignaturesAutomaticV1()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignsignatureApi#ezsignsignatureGetEzsignsignaturesAutomaticV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignsignatureApi#ezsignsignatureGetEzsignsignaturesAutomaticV1")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

EzsignsignatureGetEzsignsignaturesAutomaticV1Response

Authorization

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

HTTP request headers

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

ezsignsignatureGetObjectV2

EzsignsignatureGetObjectV2Response ezsignsignatureGetObjectV2(pkiEzsignsignatureID)

Retrieve an existing Ezsignsignature

Example

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

val apiInstance = ObjectEzsignsignatureApi()
val pkiEzsignsignatureID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignsignatureGetObjectV2Response = apiInstance.ezsignsignatureGetObjectV2(pkiEzsignsignatureID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignsignatureApi#ezsignsignatureGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignsignatureApi#ezsignsignatureGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignsignatureID kotlin.Int

Return type

EzsignsignatureGetObjectV2Response

Authorization

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

HTTP request headers

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

ezsignsignatureSignV1

EzsignsignatureSignV1Response ezsignsignatureSignV1(pkiEzsignsignatureID, ezsignsignatureSignV1Request)

Sign the Ezsignsignature

Example

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

val apiInstance = ObjectEzsignsignatureApi()
val pkiEzsignsignatureID : kotlin.Int = 56 // kotlin.Int | 
val ezsignsignatureSignV1Request : EzsignsignatureSignV1Request =  // EzsignsignatureSignV1Request | 
try {
    val result : EzsignsignatureSignV1Response = apiInstance.ezsignsignatureSignV1(pkiEzsignsignatureID, ezsignsignatureSignV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignsignatureApi#ezsignsignatureSignV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignsignatureApi#ezsignsignatureSignV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignsignatureID kotlin.Int
ezsignsignatureSignV1Request EzsignsignatureSignV1Request

Return type

EzsignsignatureSignV1Response

Authorization

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

HTTP request headers

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