Skip to content

Latest commit

 

History

History
303 lines (243 loc) · 11.6 KB

ObjectEzsignimportfolderApi.md

File metadata and controls

303 lines (243 loc) · 11.6 KB

eZmaxApi.Api.ObjectEzsignimportfolderApi

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

Method HTTP request Description
EzsignimportfolderDeleteObjectV1 DELETE /1/object/ezsignimportfolder/{pkiEzsignimportfolderID} Delete an existing Ezsignimportfolder
EzsignimportfolderGetListV1 GET /1/object/ezsignimportfolder/getList Retrieve Ezsignimportfolder list
EzsignimportfolderGetObjectV2 GET /2/object/ezsignimportfolder/{pkiEzsignimportfolderID} Retrieve an existing Ezsignimportfolder

EzsignimportfolderDeleteObjectV1

EzsignimportfolderDeleteObjectV1Response EzsignimportfolderDeleteObjectV1 (int pkiEzsignimportfolderID)

Delete an existing Ezsignimportfolder

Example

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

namespace Example
{
    public class EzsignimportfolderDeleteObjectV1Example
    {
        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 ObjectEzsignimportfolderApi(config);
            var pkiEzsignimportfolderID = 56;  // int | The unique ID of the Ezsignimportfolder

            try
            {
                // Delete an existing Ezsignimportfolder
                EzsignimportfolderDeleteObjectV1Response result = apiInstance.EzsignimportfolderDeleteObjectV1(pkiEzsignimportfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignimportfolderApi.EzsignimportfolderDeleteObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignimportfolderDeleteObjectV1WithHttpInfo variant

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

try
{
    // Delete an existing Ezsignimportfolder
    ApiResponse<EzsignimportfolderDeleteObjectV1Response> response = apiInstance.EzsignimportfolderDeleteObjectV1WithHttpInfo(pkiEzsignimportfolderID);
    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 ObjectEzsignimportfolderApi.EzsignimportfolderDeleteObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignimportfolderID int The unique ID of the Ezsignimportfolder

Return type

EzsignimportfolderDeleteObjectV1Response

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]

EzsignimportfolderGetListV1

EzsignimportfolderGetListV1Response EzsignimportfolderGetListV1 (string? eOrderBy = null, int? iRowMax = null, int? iRowOffset = null, HeaderAcceptLanguage? acceptLanguage = null, string? sFilter = null)

Retrieve Ezsignimportfolder list

Example

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

namespace Example
{
    public class EzsignimportfolderGetListV1Example
    {
        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 ObjectEzsignimportfolderApi(config);
            var eOrderBy = "pkiEzsignimportfolderID_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 Ezsignimportfolder list
                EzsignimportfolderGetListV1Response result = apiInstance.EzsignimportfolderGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignimportfolderApi.EzsignimportfolderGetListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignimportfolderGetListV1WithHttpInfo variant

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

try
{
    // Retrieve Ezsignimportfolder list
    ApiResponse<EzsignimportfolderGetListV1Response> response = apiInstance.EzsignimportfolderGetListV1WithHttpInfo(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 ObjectEzsignimportfolderApi.EzsignimportfolderGetListV1WithHttpInfo: " + 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

EzsignimportfolderGetListV1Response

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]

EzsignimportfolderGetObjectV2

EzsignimportfolderGetObjectV2Response EzsignimportfolderGetObjectV2 (int pkiEzsignimportfolderID)

Retrieve an existing Ezsignimportfolder

Example

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

namespace Example
{
    public class EzsignimportfolderGetObjectV2Example
    {
        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 ObjectEzsignimportfolderApi(config);
            var pkiEzsignimportfolderID = 56;  // int | The unique ID of the Ezsignimportfolder

            try
            {
                // Retrieve an existing Ezsignimportfolder
                EzsignimportfolderGetObjectV2Response result = apiInstance.EzsignimportfolderGetObjectV2(pkiEzsignimportfolderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignimportfolderApi.EzsignimportfolderGetObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignimportfolderGetObjectV2WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignimportfolder
    ApiResponse<EzsignimportfolderGetObjectV2Response> response = apiInstance.EzsignimportfolderGetObjectV2WithHttpInfo(pkiEzsignimportfolderID);
    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 ObjectEzsignimportfolderApi.EzsignimportfolderGetObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignimportfolderID int The unique ID of the Ezsignimportfolder

Return type

EzsignimportfolderGetObjectV2Response

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]