Skip to content

Latest commit

 

History

History
210 lines (150 loc) · 8.52 KB

ObjectCreditcardmerchantApi.md

File metadata and controls

210 lines (150 loc) · 8.52 KB

ObjectCreditcardmerchantApi

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

Method HTTP request Description
creditcardmerchantGetAutocompleteV2 GET /2/object/creditcardmerchant/getAutocomplete/{sSelector} Retrieve Creditcardmerchants and IDs
creditcardmerchantGetListV1 GET /1/object/creditcardmerchant/getList Retrieve Creditcardmerchant list
creditcardmerchantGetObjectV2 GET /2/object/creditcardmerchant/{pkiCreditcardmerchantID} Retrieve an existing Creditcardmerchant

creditcardmerchantGetAutocompleteV2

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

Retrieve Creditcardmerchants and IDs

Get the list of Creditcardmerchant 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 Creditcardmerchants 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)

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

// Retrieve Creditcardmerchants and IDs
[apiInstance creditcardmerchantGetAutocompleteV2WithSSelector:sSelector
              eFilterActive:eFilterActive
              sQuery:sQuery
              acceptLanguage:acceptLanguage
          completionHandler: ^(CreditcardmerchantGetAutocompleteV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectCreditcardmerchantApi->creditcardmerchantGetAutocompleteV2: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
sSelector NSString* The type of Creditcardmerchants 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

CreditcardmerchantGetAutocompleteV2Response*

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]

creditcardmerchantGetListV1

-(NSURLSessionTask*) creditcardmerchantGetListV1WithEOrderBy: (NSString*) eOrderBy
    iRowMax: (NSNumber*) iRowMax
    iRowOffset: (NSNumber*) iRowOffset
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
    sFilter: (NSString*) sFilter
        completionHandler: (void (^)(CreditcardmerchantGetListV1Response* output, NSError* error)) handler;

Retrieve Creditcardmerchant list

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* eOrderBy = @"eOrderBy_example"; // Specify how you want the results to be sorted (optional)
NSNumber* iRowMax = @56; //  (optional)
NSNumber* iRowOffset = @0; //  (optional) (default to @0)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; //  (optional)
NSString* sFilter = @"sFilter_example"; //  (optional)

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

// Retrieve Creditcardmerchant list
[apiInstance creditcardmerchantGetListV1WithEOrderBy:eOrderBy
              iRowMax:iRowMax
              iRowOffset:iRowOffset
              acceptLanguage:acceptLanguage
              sFilter:sFilter
          completionHandler: ^(CreditcardmerchantGetListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectCreditcardmerchantApi->creditcardmerchantGetListV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
eOrderBy NSString* Specify how you want the results to be sorted [optional]
iRowMax NSNumber* [optional]
iRowOffset NSNumber* [optional] [default to @0]
acceptLanguage HeaderAcceptLanguage [optional]
sFilter NSString* [optional]

Return type

CreditcardmerchantGetListV1Response*

Authorization

Authorization

HTTP request headers

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

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

creditcardmerchantGetObjectV2

-(NSURLSessionTask*) creditcardmerchantGetObjectV2WithPkiCreditcardmerchantID: (NSNumber*) pkiCreditcardmerchantID
        completionHandler: (void (^)(CreditcardmerchantGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Creditcardmerchant

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"];


NSNumber* pkiCreditcardmerchantID = @56; // The unique ID of the Creditcardmerchant

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

// Retrieve an existing Creditcardmerchant
[apiInstance creditcardmerchantGetObjectV2WithPkiCreditcardmerchantID:pkiCreditcardmerchantID
          completionHandler: ^(CreditcardmerchantGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectCreditcardmerchantApi->creditcardmerchantGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiCreditcardmerchantID NSNumber* The unique ID of the Creditcardmerchant

Return type

CreditcardmerchantGetObjectV2Response*

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]