Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 2.4 KB

ObjectProvinceApi.md

File metadata and controls

65 lines (47 loc) · 2.4 KB
Raw

ObjectProvinceApi

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

Method HTTP request Description
provinceGetAutocompleteV2 GET /2/object/province/getAutocomplete/{sSelector} Retrieve Provinces and IDs

provinceGetAutocompleteV2

ProvinceGetAutocompleteV2Response provinceGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Provinces and IDs

Get the list of Province to be used in a dropdown or autocomplete control.

Example

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

val apiInstance = ObjectProvinceApi()
val sSelector : kotlin.String = sSelector_example // kotlin.String | The type of Provinces to return
val eFilterActive : kotlin.String = eFilterActive_example // kotlin.String | Specify which results we want to display.
val sQuery : kotlin.String = sQuery_example // kotlin.String | Allow to filter the returned results
val acceptLanguage : HeaderAcceptLanguage =  // HeaderAcceptLanguage | 
try {
    val result : ProvinceGetAutocompleteV2Response = apiInstance.provinceGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectProvinceApi#provinceGetAutocompleteV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectProvinceApi#provinceGetAutocompleteV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
sSelector kotlin.String The type of Provinces to return [enum: All]
eFilterActive kotlin.String Specify which results we want to display. [optional] [default to Active] [enum: All, Active, Inactive]
sQuery kotlin.String Allow to filter the returned results [optional]
acceptLanguage HeaderAcceptLanguage [optional] [enum: *, en, fr]

Return type

ProvinceGetAutocompleteV2Response

Authorization

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

HTTP request headers

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