Skip to content

Latest commit

 

History

History
97 lines (67 loc) · 4.06 KB

ObjectUserlogintypeApi.md

File metadata and controls

97 lines (67 loc) · 4.06 KB
Raw

eZmaxApi.ObjectUserlogintypeApi

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

Method HTTP request Description
userlogintype_get_autocomplete_v2 GET /2/object/userlogintype/getAutocomplete/{sSelector} Retrieve Userlogintypes and IDs

userlogintype_get_autocomplete_v2

UserlogintypeGetAutocompleteV2Response userlogintype_get_autocomplete_v2(s_selector, fki_ezsignfoldertype_id=fki_ezsignfoldertype_id, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)

Retrieve Userlogintypes and IDs

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

Example

  • Api Key Authentication (Authorization):
import eZmaxApi
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.models.userlogintype_get_autocomplete_v2_response import UserlogintypeGetAutocompleteV2Response
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.ObjectUserlogintypeApi(api_client)
    s_selector = 's_selector_example' # str | The type of Userlogintypes to return
    fki_ezsignfoldertype_id = 56 # int |  (optional)
    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 Userlogintypes and IDs
        api_response = api_instance.userlogintype_get_autocomplete_v2(s_selector, fki_ezsignfoldertype_id=fki_ezsignfoldertype_id, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
        print("The response of ObjectUserlogintypeApi->userlogintype_get_autocomplete_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectUserlogintypeApi->userlogintype_get_autocomplete_v2: %s\n" % e)

Parameters

Name Type Description Notes
s_selector str The type of Userlogintypes to return
fki_ezsignfoldertype_id int [optional]
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

UserlogintypeGetAutocompleteV2Response

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]