Skip to content

Latest commit

 

History

History
570 lines (419 loc) · 20.7 KB

ObjectEzsignbulksendApi.md

File metadata and controls

570 lines (419 loc) · 20.7 KB

ObjectEzsignbulksendApi

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

Method HTTP request Description
ezsignbulksendCreateEzsignbulksendtransmissionV2 POST /2/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission Create a new Ezsignbulksendtransmission in the Ezsignbulksend
ezsignbulksendCreateObjectV1 POST /1/object/ezsignbulksend Create a new Ezsignbulksend
ezsignbulksendDeleteObjectV1 DELETE /1/object/ezsignbulksend/{pkiEzsignbulksendID} Delete an existing Ezsignbulksend
ezsignbulksendEditObjectV1 PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID} Edit an existing Ezsignbulksend
ezsignbulksendGetCsvTemplateV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getCsvTemplate Retrieve an existing Ezsignbulksend's empty Csv template
ezsignbulksendGetEzsignbulksendtransmissionsV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignbulksendtransmissions Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions
ezsignbulksendGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures
ezsignbulksendGetFormsDataV1 GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData Retrieve an existing Ezsignbulksend's forms data
ezsignbulksendGetListV1 GET /1/object/ezsignbulksend/getList Retrieve Ezsignbulksend list
ezsignbulksendGetObjectV2 GET /2/object/ezsignbulksend/{pkiEzsignbulksendID} Retrieve an existing Ezsignbulksend
ezsignbulksendReorderV1 POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend

ezsignbulksendCreateEzsignbulksendtransmissionV2

EzsignbulksendCreateEzsignbulksendtransmissionV2Response ezsignbulksendCreateEzsignbulksendtransmissionV2(pkiEzsignbulksendID, ezsignbulksendCreateEzsignbulksendtransmissionV2Request)

Create a new Ezsignbulksendtransmission in the Ezsignbulksend

Example

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

val apiInstance = ObjectEzsignbulksendApi()
val pkiEzsignbulksendID : kotlin.Int = 56 // kotlin.Int | 
val ezsignbulksendCreateEzsignbulksendtransmissionV2Request : EzsignbulksendCreateEzsignbulksendtransmissionV2Request =  // EzsignbulksendCreateEzsignbulksendtransmissionV2Request | 
try {
    val result : EzsignbulksendCreateEzsignbulksendtransmissionV2Response = apiInstance.ezsignbulksendCreateEzsignbulksendtransmissionV2(pkiEzsignbulksendID, ezsignbulksendCreateEzsignbulksendtransmissionV2Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendCreateEzsignbulksendtransmissionV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendCreateEzsignbulksendtransmissionV2")
    e.printStackTrace()
}

Parameters

| pkiEzsignbulksendID | kotlin.Int| | |

Name Type Description Notes
ezsignbulksendCreateEzsignbulksendtransmissionV2Request EzsignbulksendCreateEzsignbulksendtransmissionV2Request

Return type

EzsignbulksendCreateEzsignbulksendtransmissionV2Response

Authorization

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

HTTP request headers

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

ezsignbulksendCreateObjectV1

EzsignbulksendCreateObjectV1Response ezsignbulksendCreateObjectV1(ezsignbulksendCreateObjectV1Request)

Create a new Ezsignbulksend

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

Example

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

val apiInstance = ObjectEzsignbulksendApi()
val ezsignbulksendCreateObjectV1Request : EzsignbulksendCreateObjectV1Request =  // EzsignbulksendCreateObjectV1Request | 
try {
    val result : EzsignbulksendCreateObjectV1Response = apiInstance.ezsignbulksendCreateObjectV1(ezsignbulksendCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ezsignbulksendCreateObjectV1Request EzsignbulksendCreateObjectV1Request

Return type

EzsignbulksendCreateObjectV1Response

Authorization

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

HTTP request headers

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

ezsignbulksendDeleteObjectV1

EzsignbulksendDeleteObjectV1Response ezsignbulksendDeleteObjectV1(pkiEzsignbulksendID)

Delete an existing Ezsignbulksend

Example

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

val apiInstance = ObjectEzsignbulksendApi()
val pkiEzsignbulksendID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignbulksendDeleteObjectV1Response = apiInstance.ezsignbulksendDeleteObjectV1(pkiEzsignbulksendID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendDeleteObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendDeleteObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID kotlin.Int

Return type

EzsignbulksendDeleteObjectV1Response

Authorization

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

HTTP request headers

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

ezsignbulksendEditObjectV1

EzsignbulksendEditObjectV1Response ezsignbulksendEditObjectV1(pkiEzsignbulksendID, ezsignbulksendEditObjectV1Request)

Edit an existing Ezsignbulksend

Example

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

val apiInstance = ObjectEzsignbulksendApi()
val pkiEzsignbulksendID : kotlin.Int = 56 // kotlin.Int | 
val ezsignbulksendEditObjectV1Request : EzsignbulksendEditObjectV1Request =  // EzsignbulksendEditObjectV1Request | 
try {
    val result : EzsignbulksendEditObjectV1Response = apiInstance.ezsignbulksendEditObjectV1(pkiEzsignbulksendID, ezsignbulksendEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendEditObjectV1")
    e.printStackTrace()
}

Parameters

| pkiEzsignbulksendID | kotlin.Int| | |

Name Type Description Notes
ezsignbulksendEditObjectV1Request EzsignbulksendEditObjectV1Request

Return type

EzsignbulksendEditObjectV1Response

Authorization

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

HTTP request headers

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

ezsignbulksendGetCsvTemplateV1

kotlin.String ezsignbulksendGetCsvTemplateV1(pkiEzsignbulksendID, eCsvSeparator)

Retrieve an existing Ezsignbulksend's empty Csv template

Example

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

val apiInstance = ObjectEzsignbulksendApi()
val pkiEzsignbulksendID : kotlin.Int = 56 // kotlin.Int | 
val eCsvSeparator : kotlin.String = eCsvSeparator_example // kotlin.String | Separator that will be used to separate fields
try {
    val result : kotlin.String = apiInstance.ezsignbulksendGetCsvTemplateV1(pkiEzsignbulksendID, eCsvSeparator)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetCsvTemplateV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetCsvTemplateV1")
    e.printStackTrace()
}

Parameters

| pkiEzsignbulksendID | kotlin.Int| | |

Name Type Description Notes
eCsvSeparator kotlin.String Separator that will be used to separate fields [enum: Comma, Semicolon]

Return type

kotlin.String

Authorization

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

HTTP request headers

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

ezsignbulksendGetEzsignbulksendtransmissionsV1

EzsignbulksendGetEzsignbulksendtransmissionsV1Response ezsignbulksendGetEzsignbulksendtransmissionsV1(pkiEzsignbulksendID)

Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions

Example

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

val apiInstance = ObjectEzsignbulksendApi()
val pkiEzsignbulksendID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignbulksendGetEzsignbulksendtransmissionsV1Response = apiInstance.ezsignbulksendGetEzsignbulksendtransmissionsV1(pkiEzsignbulksendID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetEzsignbulksendtransmissionsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetEzsignbulksendtransmissionsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID kotlin.Int

Return type

EzsignbulksendGetEzsignbulksendtransmissionsV1Response

Authorization

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

HTTP request headers

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

ezsignbulksendGetEzsignsignaturesAutomaticV1

EzsignbulksendGetEzsignsignaturesAutomaticV1Response ezsignbulksendGetEzsignsignaturesAutomaticV1(pkiEzsignbulksendID)

Retrieve an existing Ezsignbulksend'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 = ObjectEzsignbulksendApi()
val pkiEzsignbulksendID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignbulksendGetEzsignsignaturesAutomaticV1Response = apiInstance.ezsignbulksendGetEzsignsignaturesAutomaticV1(pkiEzsignbulksendID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetEzsignsignaturesAutomaticV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetEzsignsignaturesAutomaticV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID kotlin.Int

Return type

EzsignbulksendGetEzsignsignaturesAutomaticV1Response

Authorization

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

HTTP request headers

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

ezsignbulksendGetFormsDataV1

EzsignbulksendGetFormsDataV1Response ezsignbulksendGetFormsDataV1(pkiEzsignbulksendID)

Retrieve an existing Ezsignbulksend's forms data

Example

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

val apiInstance = ObjectEzsignbulksendApi()
val pkiEzsignbulksendID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignbulksendGetFormsDataV1Response = apiInstance.ezsignbulksendGetFormsDataV1(pkiEzsignbulksendID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetFormsDataV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetFormsDataV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID kotlin.Int

Return type

EzsignbulksendGetFormsDataV1Response

Authorization

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

HTTP request headers

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

ezsignbulksendGetListV1

EzsignbulksendGetListV1Response ezsignbulksendGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Ezsignbulksend list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsignfoldertypePrivacylevel | User<br>Usergroup |

Example

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

val apiInstance = ObjectEzsignbulksendApi()
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 : EzsignbulksendGetListV1Response = apiInstance.ezsignbulksendGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetListV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetListV1")
    e.printStackTrace()
}

Parameters

| eOrderBy | kotlin.String| Specify how you want the results to be sorted | [optional] [enum: pkiEzsignbulksendID_ASC, pkiEzsignbulksendID_DESC, fkiEzsignfoldertypeID_ASC, fkiEzsignfoldertypeID_DESC, sEzsignbulksendDescription_ASC, sEzsignbulksendDescription_DESC, sEzsignfoldertypeNameX_ASC, sEzsignfoldertypeNameX_DESC, eEzsignfoldertypePrivacylevel_ASC, eEzsignfoldertypePrivacylevel_DESC, bEzsignbulksendNeedvalidation_ASC, bEzsignbulksendNeedvalidation_DESC, iEzsignbulksendtransmission_ASC, iEzsignbulksendtransmission_DESC, iEzsignfolder_ASC, iEzsignfolder_DESC, iEzsigndocument_ASC, iEzsigndocument_DESC, iEzsignsignature_ASC, iEzsignsignature_DESC, iEzsignsignatureSigned_ASC, iEzsignsignatureSigned_DESC, bEzsignbulksendIsactive_ASC, bEzsignbulksendIsactive_DESC] | | iRowMax | kotlin.Int| | [optional] | | iRowOffset | kotlin.Int| | [optional] [default to 0] | | acceptLanguage | HeaderAcceptLanguage| | [optional] [enum: *, en, fr] |

Name Type Description Notes
sFilter kotlin.String [optional]

Return type

EzsignbulksendGetListV1Response

Authorization

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

HTTP request headers

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

ezsignbulksendGetObjectV2

EzsignbulksendGetObjectV2Response ezsignbulksendGetObjectV2(pkiEzsignbulksendID)

Retrieve an existing Ezsignbulksend

Example

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

val apiInstance = ObjectEzsignbulksendApi()
val pkiEzsignbulksendID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : EzsignbulksendGetObjectV2Response = apiInstance.ezsignbulksendGetObjectV2(pkiEzsignbulksendID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiEzsignbulksendID kotlin.Int

Return type

EzsignbulksendGetObjectV2Response

Authorization

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

HTTP request headers

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

ezsignbulksendReorderV1

EzsignbulksendReorderV1Response ezsignbulksendReorderV1(pkiEzsignbulksendID, ezsignbulksendReorderV1Request)

Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend

Example

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

val apiInstance = ObjectEzsignbulksendApi()
val pkiEzsignbulksendID : kotlin.Int = 56 // kotlin.Int | 
val ezsignbulksendReorderV1Request : EzsignbulksendReorderV1Request =  // EzsignbulksendReorderV1Request | 
try {
    val result : EzsignbulksendReorderV1Response = apiInstance.ezsignbulksendReorderV1(pkiEzsignbulksendID, ezsignbulksendReorderV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectEzsignbulksendApi#ezsignbulksendReorderV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectEzsignbulksendApi#ezsignbulksendReorderV1")
    e.printStackTrace()
}

Parameters

| pkiEzsignbulksendID | kotlin.Int| | |

Name Type Description Notes
ezsignbulksendReorderV1Request EzsignbulksendReorderV1Request

Return type

EzsignbulksendReorderV1Response

Authorization

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

HTTP request headers

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