Skip to content

Latest commit

 

History

History
602 lines (483 loc) · 23.2 KB

ObjectCreditcardclientApi.md

File metadata and controls

602 lines (483 loc) · 23.2 KB

eZmaxApi.Api.ObjectCreditcardclientApi

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 creditcardclientCreateObjectV1Request)

Create a new Creditcardclient

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class CreditcardclientCreateObjectV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectCreditcardclientApi(config);
            var creditcardclientCreateObjectV1Request = new CreditcardclientCreateObjectV1Request(); // CreditcardclientCreateObjectV1Request | 

            try
            {
                // Create a new Creditcardclient
                CreditcardclientCreateObjectV1Response result = apiInstance.CreditcardclientCreateObjectV1(creditcardclientCreateObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientCreateObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreditcardclientCreateObjectV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Create a new Creditcardclient
    ApiResponse<CreditcardclientCreateObjectV1Response> response = apiInstance.CreditcardclientCreateObjectV1WithHttpInfo(creditcardclientCreateObjectV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientCreateObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
creditcardclientCreateObjectV1Request CreditcardclientCreateObjectV1Request

Return type

CreditcardclientCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Successful response -

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

CreditcardclientDeleteObjectV1

CreditcardclientDeleteObjectV1Response CreditcardclientDeleteObjectV1 (int pkiCreditcardclientID)

Delete an existing Creditcardclient

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class CreditcardclientDeleteObjectV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectCreditcardclientApi(config);
            var pkiCreditcardclientID = 56;  // int | The unique ID of the Creditcardclient

            try
            {
                // Delete an existing Creditcardclient
                CreditcardclientDeleteObjectV1Response result = apiInstance.CreditcardclientDeleteObjectV1(pkiCreditcardclientID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientDeleteObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreditcardclientDeleteObjectV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Delete an existing Creditcardclient
    ApiResponse<CreditcardclientDeleteObjectV1Response> response = apiInstance.CreditcardclientDeleteObjectV1WithHttpInfo(pkiCreditcardclientID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientDeleteObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

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

HTTP response details

Status code Description Response headers
200 Successful response -
404 The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body -

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

CreditcardclientEditObjectV1

CreditcardclientEditObjectV1Response CreditcardclientEditObjectV1 (int pkiCreditcardclientID, CreditcardclientEditObjectV1Request creditcardclientEditObjectV1Request)

Edit an existing Creditcardclient

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class CreditcardclientEditObjectV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectCreditcardclientApi(config);
            var pkiCreditcardclientID = 56;  // int | The unique ID of the Creditcardclient
            var creditcardclientEditObjectV1Request = new CreditcardclientEditObjectV1Request(); // CreditcardclientEditObjectV1Request | 

            try
            {
                // Edit an existing Creditcardclient
                CreditcardclientEditObjectV1Response result = apiInstance.CreditcardclientEditObjectV1(pkiCreditcardclientID, creditcardclientEditObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientEditObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreditcardclientEditObjectV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Edit an existing Creditcardclient
    ApiResponse<CreditcardclientEditObjectV1Response> response = apiInstance.CreditcardclientEditObjectV1WithHttpInfo(pkiCreditcardclientID, creditcardclientEditObjectV1Request);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientEditObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

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

HTTP response details

Status code Description Response headers
200 Successful response -
404 The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body -
422 The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body -

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

CreditcardclientGetAutocompleteV2

CreditcardclientGetAutocompleteV2Response CreditcardclientGetAutocompleteV2 (string sSelector, string? eFilterActive = null, string? sQuery = null, HeaderAcceptLanguage? acceptLanguage = null)

Retrieve Creditcardclients and IDs

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class CreditcardclientGetAutocompleteV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectCreditcardclientApi(config);
            var sSelector = "All";  // string | The type of Creditcardclients to return
            var eFilterActive = "All";  // string? | Specify which results we want to display. (optional)  (default to Active)
            var sQuery = "sQuery_example";  // string? | Allow to filter the returned results (optional) 
            var acceptLanguage = new HeaderAcceptLanguage?(); // HeaderAcceptLanguage? |  (optional) 

            try
            {
                // Retrieve Creditcardclients and IDs
                CreditcardclientGetAutocompleteV2Response result = apiInstance.CreditcardclientGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientGetAutocompleteV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreditcardclientGetAutocompleteV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve Creditcardclients and IDs
    ApiResponse<CreditcardclientGetAutocompleteV2Response> response = apiInstance.CreditcardclientGetAutocompleteV2WithHttpInfo(sSelector, eFilterActive, sQuery, acceptLanguage);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientGetAutocompleteV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

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

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]

CreditcardclientGetListV1

CreditcardclientGetListV1Response CreditcardclientGetListV1 (string? eOrderBy = null, int? iRowMax = null, int? iRowOffset = null, HeaderAcceptLanguage? acceptLanguage = null, string? sFilter = null)

Retrieve Creditcardclient list

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class CreditcardclientGetListV1Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectCreditcardclientApi(config);
            var eOrderBy = "pkiCreditcardclientID_ASC";  // string? | Specify how you want the results to be sorted (optional) 
            var iRowMax = 56;  // int? |  (optional) 
            var iRowOffset = 0;  // int? |  (optional)  (default to 0)
            var acceptLanguage = new HeaderAcceptLanguage?(); // HeaderAcceptLanguage? |  (optional) 
            var sFilter = "sFilter_example";  // string? |  (optional) 

            try
            {
                // Retrieve Creditcardclient list
                CreditcardclientGetListV1Response result = apiInstance.CreditcardclientGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientGetListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreditcardclientGetListV1WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve Creditcardclient list
    ApiResponse<CreditcardclientGetListV1Response> response = apiInstance.CreditcardclientGetListV1WithHttpInfo(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientGetListV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

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

HTTP response details

Status code Description Response headers
200 Successful response -
406 The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header &quot;Accept: application/json&quot; but the function can only return &quot;Content-type: image/png&quot; -

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

CreditcardclientGetObjectV2

CreditcardclientGetObjectV2Response CreditcardclientGetObjectV2 (int pkiCreditcardclientID)

Retrieve an existing Creditcardclient

Example

using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;

namespace Example
{
    public class CreditcardclientGetObjectV2Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest";
            // Configure API key authorization: Authorization
            config.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new ObjectCreditcardclientApi(config);
            var pkiCreditcardclientID = 56;  // int | The unique ID of the Creditcardclient

            try
            {
                // Retrieve an existing Creditcardclient
                CreditcardclientGetObjectV2Response result = apiInstance.CreditcardclientGetObjectV2(pkiCreditcardclientID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientGetObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CreditcardclientGetObjectV2WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve an existing Creditcardclient
    ApiResponse<CreditcardclientGetObjectV2Response> response = apiInstance.CreditcardclientGetObjectV2WithHttpInfo(pkiCreditcardclientID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling ObjectCreditcardclientApi.CreditcardclientGetObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

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

HTTP response details

Status code Description Response headers
200 Successful response -
404 The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body -

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