Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.76 KB

ObjectFranchiseofficeApi.md

File metadata and controls

71 lines (50 loc) · 2.76 KB
Raw

EzmaxApi::ObjectFranchiseofficeApi

Load the API package

use EzmaxApi::Object::ObjectFranchiseofficeApi;

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

Method HTTP request Description
franchiseoffice_get_autocomplete_v2 GET /2/object/franchiseoffice/getAutocomplete/{sSelector} Retrieve Franchiseoffices and IDs

franchiseoffice_get_autocomplete_v2

FranchiseofficeGetAutocompleteV2Response franchiseoffice_get_autocomplete_v2(s_selector => $s_selector, e_filter_active => $e_filter_active, s_query => $s_query, accept_language => $accept_language)

Retrieve Franchiseoffices and IDs

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

Example

use Data::Dumper;
use EzmaxApi::ObjectFranchiseofficeApi;
my $api_instance = EzmaxApi::ObjectFranchiseofficeApi->new(

    # Configure API key authorization: Authorization
    api_key => {'Authorization' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Authorization' => 'Bearer'},
);

my $s_selector = "s_selector_example"; # string | The type of Franchiseoffices to return
my $e_filter_active = 'Active'; # string | Specify which results we want to display.
my $s_query = "s_query_example"; # string | Allow to filter the returned results
my $accept_language = new EzmaxApi.HeaderAcceptLanguage(); # HeaderAcceptLanguage | 

eval {
    my $result = $api_instance->franchiseoffice_get_autocomplete_v2(s_selector => $s_selector, e_filter_active => $e_filter_active, s_query => $s_query, accept_language => $accept_language);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ObjectFranchiseofficeApi->franchiseoffice_get_autocomplete_v2: $@\n";
}

Parameters

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

Return type

FranchiseofficeGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

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

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