Skip to content

Latest commit

 

History

History
161 lines (112 loc) · 4.8 KB

ObjectInscriptionApi.md

File metadata and controls

161 lines (112 loc) · 4.8 KB

ObjectInscriptionApi

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

Method HTTP request Description
inscriptionGetAttachmentsV1 GET /1/object/inscription/{pkiInscriptionID}/getAttachments Retrieve Inscription's Attachments
inscriptionGetCommunicationListV1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList Retrieve Communication list
inscriptionGetCommunicationsendersV1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationsenders Retrieve Inscription's Communicationsender

inscriptionGetAttachmentsV1

InscriptionGetAttachmentsV1Response inscriptionGetAttachmentsV1(pkiInscriptionID)

Retrieve Inscription's Attachments

Example

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

val apiInstance = ObjectInscriptionApi()
val pkiInscriptionID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : InscriptionGetAttachmentsV1Response = apiInstance.inscriptionGetAttachmentsV1(pkiInscriptionID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectInscriptionApi#inscriptionGetAttachmentsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectInscriptionApi#inscriptionGetAttachmentsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiInscriptionID kotlin.Int

Return type

InscriptionGetAttachmentsV1Response

Authorization

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

HTTP request headers

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

inscriptionGetCommunicationListV1

InscriptionGetCommunicationListV1Response inscriptionGetCommunicationListV1(pkiInscriptionID)

Retrieve Communication list

Example

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

val apiInstance = ObjectInscriptionApi()
val pkiInscriptionID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : InscriptionGetCommunicationListV1Response = apiInstance.inscriptionGetCommunicationListV1(pkiInscriptionID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectInscriptionApi#inscriptionGetCommunicationListV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectInscriptionApi#inscriptionGetCommunicationListV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiInscriptionID kotlin.Int

Return type

InscriptionGetCommunicationListV1Response

Authorization

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

HTTP request headers

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

inscriptionGetCommunicationsendersV1

InscriptionGetCommunicationsendersV1Response inscriptionGetCommunicationsendersV1(pkiInscriptionID)

Retrieve Inscription's Communicationsender

Example

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

val apiInstance = ObjectInscriptionApi()
val pkiInscriptionID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : InscriptionGetCommunicationsendersV1Response = apiInstance.inscriptionGetCommunicationsendersV1(pkiInscriptionID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectInscriptionApi#inscriptionGetCommunicationsendersV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectInscriptionApi#inscriptionGetCommunicationsendersV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiInscriptionID kotlin.Int

Return type

InscriptionGetCommunicationsendersV1Response

Authorization

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

HTTP request headers

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