Skip to content

Latest commit

 

History

History
108 lines (77 loc) · 3.14 KB

ObjectCustomerApi.md

File metadata and controls

108 lines (77 loc) · 3.14 KB

ObjectCustomerApi

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

Method HTTP request Description
customerCreateObjectV1 POST /1/object/customer Create a new Customer
customerGetObjectV2 GET /2/object/customer/{pkiCustomerID} Retrieve an existing Customer

customerCreateObjectV1

CustomerCreateObjectV1Response customerCreateObjectV1(customerCreateObjectV1Request)

Create a new Customer

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

Example

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

val apiInstance = ObjectCustomerApi()
val customerCreateObjectV1Request : CustomerCreateObjectV1Request =  // CustomerCreateObjectV1Request | 
try {
    val result : CustomerCreateObjectV1Response = apiInstance.customerCreateObjectV1(customerCreateObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectCustomerApi#customerCreateObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectCustomerApi#customerCreateObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
customerCreateObjectV1Request CustomerCreateObjectV1Request

Return type

CustomerCreateObjectV1Response

Authorization

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

HTTP request headers

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

customerGetObjectV2

CustomerGetObjectV2Response customerGetObjectV2(pkiCustomerID)

Retrieve an existing Customer

Example

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

val apiInstance = ObjectCustomerApi()
val pkiCustomerID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Customer
try {
    val result : CustomerGetObjectV2Response = apiInstance.customerGetObjectV2(pkiCustomerID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectCustomerApi#customerGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectCustomerApi#customerGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiCustomerID kotlin.Int The unique ID of the Customer

Return type

CustomerGetObjectV2Response

Authorization

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

HTTP request headers

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