Skip to content

Latest commit

 

History

History
260 lines (176 loc) · 9.69 KB

ObjectCustomerApi.md

File metadata and controls

260 lines (176 loc) · 9.69 KB

eZmaxApi.ObjectCustomerApi

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

Method HTTP request Description
customer_get_autocomplete_v2 GET /2/object/customer/getAutocomplete/{sSelector} Retrieve Customers and IDs
customer_get_object_v2 GET /2/object/customer/{pkiCustomerID} Retrieve an existing Customer
customer_import_into_edmv1 POST /1/object/customer/{pkiCustomerID}/importIntoEDM Import attachments into the Customer

customer_get_autocomplete_v2

CustomerGetAutocompleteV2Response customer_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)

Retrieve Customers and IDs

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

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.customer_get_autocomplete_v2_response import CustomerGetAutocompleteV2Response
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectCustomerApi(api_client)
    s_selector = 's_selector_example' # str | The type of Customers to return
    e_filter_active = Active # str | Specify which results we want to display. (optional) (default to Active)
    s_query = 's_query_example' # str | Allow to filter the returned results (optional)
    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)

    try:
        # Retrieve Customers and IDs
        api_response = api_instance.customer_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
        print("The response of ObjectCustomerApi->customer_get_autocomplete_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectCustomerApi->customer_get_autocomplete_v2: %s\n" % e)

Parameters

Name Type Description Notes
s_selector str The type of Customers to return
e_filter_active str Specify which results we want to display. [optional] [default to Active]
s_query str Allow to filter the returned results [optional]
accept_language HeaderAcceptLanguage [optional]

Return type

CustomerGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customer_get_object_v2

CustomerGetObjectV2Response customer_get_object_v2(pki_customer_id)

Retrieve an existing Customer

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.customer_get_object_v2_response import CustomerGetObjectV2Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectCustomerApi(api_client)
    pki_customer_id = 56 # int | The unique ID of the Customer

    try:
        # Retrieve an existing Customer
        api_response = api_instance.customer_get_object_v2(pki_customer_id)
        print("The response of ObjectCustomerApi->customer_get_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectCustomerApi->customer_get_object_v2: %s\n" % e)

Parameters

Name Type Description Notes
pki_customer_id int The unique ID of the Customer

Return type

CustomerGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
404 The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

customer_import_into_edmv1

CustomerImportIntoEDMV1Response customer_import_into_edmv1(pki_customer_id, customer_import_into_edmv1_request)

Import attachments into the Customer

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.customer_import_into_edmv1_request import CustomerImportIntoEDMV1Request
from eZmaxApi.models.customer_import_into_edmv1_response import CustomerImportIntoEDMV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectCustomerApi(api_client)
    pki_customer_id = 56 # int | 
    customer_import_into_edmv1_request = eZmaxApi.CustomerImportIntoEDMV1Request() # CustomerImportIntoEDMV1Request | 

    try:
        # Import attachments into the Customer
        api_response = api_instance.customer_import_into_edmv1(pki_customer_id, customer_import_into_edmv1_request)
        print("The response of ObjectCustomerApi->customer_import_into_edmv1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectCustomerApi->customer_import_into_edmv1: %s\n" % e)

Parameters

Name Type Description Notes
pki_customer_id int
customer_import_into_edmv1_request CustomerImportIntoEDMV1Request

Return type

CustomerImportIntoEDMV1Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
404 The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body -

[Back to top] [Back to API list] [Back to Model list] [Back to README]