ObjectFranchiseofficeApi.md

ObjectFranchiseofficeApi

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

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

franchiseofficeGetAutocompleteV2

-(NSURLSessionTask*) franchiseofficeGetAutocompleteV2WithSSelector: (NSString*) sSelector
    eFilterActive: (NSString*) eFilterActive
    sQuery: (NSString*) sQuery
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
        completionHandler: (void (^)(FranchiseofficeGetAutocompleteV2Response* output, NSError* error)) handler;

Retrieve Franchiseoffices and IDs

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

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSString* sSelector = @"sSelector_example"; // The type of Franchiseoffices to return
NSString* eFilterActive = @"Active"; // Specify which results we want to display. (optional) (default to @"Active")
NSString* sQuery = @"sQuery_example"; // Allow to filter the returned results (optional)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; //  (optional)

ObjectFranchiseofficeApi*apiInstance = [[ObjectFranchiseofficeApi alloc] init];

// Retrieve Franchiseoffices and IDs
[apiInstance franchiseofficeGetAutocompleteV2WithSSelector:sSelector
              eFilterActive:eFilterActive
              sQuery:sQuery
              acceptLanguage:acceptLanguage
          completionHandler: ^(FranchiseofficeGetAutocompleteV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectFranchiseofficeApi->franchiseofficeGetAutocompleteV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
sSelector	NSString*	The type of Franchiseoffices to return
eFilterActive	NSString*	Specify which results we want to display.	[optional] [default to @"Active"]
sQuery	NSString*	Allow to filter the returned results	[optional]
acceptLanguage	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]