Skip to content

Latest commit

 

History

History
317 lines (218 loc) · 12 KB

ObjectCreditcardclientApi.md

File metadata and controls

317 lines (218 loc) · 12 KB
Raw

openapi.api.ObjectCreditcardclientApi

Load the API package

import 'package:openapi/api.dart';

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

Method HTTP request Description
creditcardclientCreateObjectV1 POST /1/object/creditcardclient Create a new Creditcardclient
creditcardclientDeleteObjectV1 DELETE /1/object/creditcardclient/{pkiCreditcardclientID} Delete an existing Creditcardclient
creditcardclientEditObjectV1 PUT /1/object/creditcardclient/{pkiCreditcardclientID} Edit an existing Creditcardclient
creditcardclientGetAutocompleteV2 GET /2/object/creditcardclient/getAutocomplete/{sSelector} Retrieve Creditcardclients and IDs
creditcardclientGetListV1 GET /1/object/creditcardclient/getList Retrieve Creditcardclient list
creditcardclientGetObjectV2 GET /2/object/creditcardclient/{pkiCreditcardclientID} Retrieve an existing Creditcardclient

creditcardclientCreateObjectV1

CreditcardclientCreateObjectV1Response creditcardclientCreateObjectV1(creditcardclientCreateObjectV1Request)

Create a new Creditcardclient

The endpoint allows to create one or many elements at once.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectCreditcardclientApi();
final creditcardclientCreateObjectV1Request = CreditcardclientCreateObjectV1Request(); // CreditcardclientCreateObjectV1Request | 

try {
    final result = api_instance.creditcardclientCreateObjectV1(creditcardclientCreateObjectV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectCreditcardclientApi->creditcardclientCreateObjectV1: $e\n');
}

Parameters

Name Type Description Notes
creditcardclientCreateObjectV1Request CreditcardclientCreateObjectV1Request

Return type

CreditcardclientCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

creditcardclientDeleteObjectV1

CreditcardclientDeleteObjectV1Response creditcardclientDeleteObjectV1(pkiCreditcardclientID)

Delete an existing Creditcardclient

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectCreditcardclientApi();
final pkiCreditcardclientID = 56; // int | The unique ID of the Creditcardclient

try {
    final result = api_instance.creditcardclientDeleteObjectV1(pkiCreditcardclientID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectCreditcardclientApi->creditcardclientDeleteObjectV1: $e\n');
}

Parameters

Name Type Description Notes
pkiCreditcardclientID int The unique ID of the Creditcardclient

Return type

CreditcardclientDeleteObjectV1Response

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]

creditcardclientEditObjectV1

CreditcardclientEditObjectV1Response creditcardclientEditObjectV1(pkiCreditcardclientID, creditcardclientEditObjectV1Request)

Edit an existing Creditcardclient

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectCreditcardclientApi();
final pkiCreditcardclientID = 56; // int | The unique ID of the Creditcardclient
final creditcardclientEditObjectV1Request = CreditcardclientEditObjectV1Request(); // CreditcardclientEditObjectV1Request | 

try {
    final result = api_instance.creditcardclientEditObjectV1(pkiCreditcardclientID, creditcardclientEditObjectV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectCreditcardclientApi->creditcardclientEditObjectV1: $e\n');
}

Parameters

Name Type Description Notes
pkiCreditcardclientID int The unique ID of the Creditcardclient
creditcardclientEditObjectV1Request CreditcardclientEditObjectV1Request

Return type

CreditcardclientEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

creditcardclientGetAutocompleteV2

CreditcardclientGetAutocompleteV2Response creditcardclientGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Creditcardclients and IDs

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

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectCreditcardclientApi();
final sSelector = sSelector_example; // String | The type of Creditcardclients to return
final eFilterActive = eFilterActive_example; // String | Specify which results we want to display.
final sQuery = sQuery_example; // String | Allow to filter the returned results
final acceptLanguage = ; // HeaderAcceptLanguage | 

try {
    final result = api_instance.creditcardclientGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
    print(result);
} catch (e) {
    print('Exception when calling ObjectCreditcardclientApi->creditcardclientGetAutocompleteV2: $e\n');
}

Parameters

Name Type Description Notes
sSelector String The type of Creditcardclients to return
eFilterActive String Specify which results we want to display. [optional] [default to 'Active']
sQuery String Allow to filter the returned results [optional]
acceptLanguage HeaderAcceptLanguage [optional]

Return type

CreditcardclientGetAutocompleteV2Response

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]

creditcardclientGetListV1

CreditcardclientGetListV1Response creditcardclientGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Creditcardclient list

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectCreditcardclientApi();
final eOrderBy = eOrderBy_example; // String | Specify how you want the results to be sorted
final iRowMax = 56; // int | 
final iRowOffset = 56; // int | 
final acceptLanguage = ; // HeaderAcceptLanguage | 
final sFilter = sFilter_example; // String | 

try {
    final result = api_instance.creditcardclientGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    print(result);
} catch (e) {
    print('Exception when calling ObjectCreditcardclientApi->creditcardclientGetListV1: $e\n');
}

Parameters

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

Return type

CreditcardclientGetListV1Response

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]

creditcardclientGetObjectV2

CreditcardclientGetObjectV2Response creditcardclientGetObjectV2(pkiCreditcardclientID)

Retrieve an existing Creditcardclient

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectCreditcardclientApi();
final pkiCreditcardclientID = 56; // int | The unique ID of the Creditcardclient

try {
    final result = api_instance.creditcardclientGetObjectV2(pkiCreditcardclientID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectCreditcardclientApi->creditcardclientGetObjectV2: $e\n');
}

Parameters

Name Type Description Notes
pkiCreditcardclientID int The unique ID of the Creditcardclient

Return type

CreditcardclientGetObjectV2Response

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]