ObjectLeadApi.md

eZmaxApi.ObjectLeadApi

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

Method	HTTP request	Description
lead_get_list_v1	GET /1/object/lead/getList	Retrieve Lead list
lead_import_into_edmv1	POST /1/object/lead/{pkiLeadID}/importIntoEDM	Import attachments into the Lead

lead_get_list_v1

LeadGetListV1Response lead_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)

Retrieve Lead list

Enum values that can be filtered in query parameter sFilter:

Variable	Valid values
eLeadStatus	New Dispatching Assigned Lost Won

Example

• Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.models.lead_get_list_v1_response import LeadGetListV1Response
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.ObjectLeadApi(api_client)
    e_order_by = 'e_order_by_example' # str | Specify how you want the results to be sorted (optional)
    i_row_max = 56 # int |  (optional)
    i_row_offset = 0 # int |  (optional) (default to 0)
    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)
    s_filter = 's_filter_example' # str |  (optional)

    try:
        # Retrieve Lead list
        api_response = api_instance.lead_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)
        print("The response of ObjectLeadApi->lead_get_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectLeadApi->lead_get_list_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
e_order_by	str	Specify how you want the results to be sorted	[optional]
i_row_max	int		[optional]
i_row_offset	int		[optional] [default to 0]
accept_language	HeaderAcceptLanguage		[optional]
s_filter	str		[optional]

Return type

LeadGetListV1Response

Authorization

Authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

HTTP response details

Status code	Description	Response headers
200	Successful response	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-

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

lead_import_into_edmv1

LeadImportIntoEDMV1Response lead_import_into_edmv1(pki_lead_id, lead_import_into_edmv1_request)

Import attachments into the Lead

Example

• Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.lead_import_into_edmv1_request import LeadImportIntoEDMV1Request
from eZmaxApi.models.lead_import_into_edmv1_response import LeadImportIntoEDMV1Response
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.ObjectLeadApi(api_client)
    pki_lead_id = 56 # int | 
    lead_import_into_edmv1_request = eZmaxApi.LeadImportIntoEDMV1Request() # LeadImportIntoEDMV1Request | 

    try:
        # Import attachments into the Lead
        api_response = api_instance.lead_import_into_edmv1(pki_lead_id, lead_import_into_edmv1_request)
        print("The response of ObjectLeadApi->lead_import_into_edmv1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectLeadApi->lead_import_into_edmv1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_lead_id	int
lead_import_into_edmv1_request	LeadImportIntoEDMV1Request

Return type

LeadImportIntoEDMV1Response

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]