Skip to content

Latest commit

 

History

History
987 lines (790 loc) · 42.3 KB

ObjectEzsignfoldersignerassociationApi.md

File metadata and controls

987 lines (790 loc) · 42.3 KB
Raw

eZmaxApi.Api.ObjectEzsignfoldersignerassociationApi

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

Method HTTP request Description
EzsignfoldersignerassociationCreateEmbeddedUrlV1 POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/createEmbeddedUrl Creates an Url to allow embedded signing
EzsignfoldersignerassociationCreateObjectV1 POST /1/object/ezsignfoldersignerassociation Create a new Ezsignfoldersignerassociation
EzsignfoldersignerassociationCreateObjectV2 POST /2/object/ezsignfoldersignerassociation Create a new Ezsignfoldersignerassociation
EzsignfoldersignerassociationDeleteObjectV1 DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Delete an existing Ezsignfoldersignerassociation
EzsignfoldersignerassociationEditObjectV1 PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Edit an existing Ezsignfoldersignerassociation
EzsignfoldersignerassociationForceDisconnectV1 POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/forceDisconnect Disconnects the Ezsignfoldersignerassociation
EzsignfoldersignerassociationGetInPersonLoginUrlV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getInPersonLoginUrl Retrieve a Login Url to allow In-Person signing
EzsignfoldersignerassociationGetObjectV1 GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Retrieve an existing Ezsignfoldersignerassociation
EzsignfoldersignerassociationGetObjectV2 GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Retrieve an existing Ezsignfoldersignerassociation
EzsignfoldersignerassociationPatchObjectV1 PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID} Patch an existing Ezsignfoldersignerassociation

EzsignfoldersignerassociationCreateEmbeddedUrlV1

EzsignfoldersignerassociationCreateEmbeddedUrlV1Response EzsignfoldersignerassociationCreateEmbeddedUrlV1 (int pkiEzsignfoldersignerassociationID, EzsignfoldersignerassociationCreateEmbeddedUrlV1Request ezsignfoldersignerassociationCreateEmbeddedUrlV1Request)

Creates an Url to allow embedded signing

This endpoint creates an Url that can be used in a browser or embedded in an I-Frame to allow signing. The signer Login type must be configured as Embedded. There will be a list to retrieve informations after the signing happens in the embedded version. To do so, there is a list of parameter to add to your sReturnUrl. In example: https://www.example.com/sReturl?sParameter1&sParameter2. The sParameter1 et sParameter2 will be replace when we will redirect on the url.

Example

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

namespace Example
{
    public class EzsignfoldersignerassociationCreateEmbeddedUrlV1Example
    {
        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 ObjectEzsignfoldersignerassociationApi(config);
            var pkiEzsignfoldersignerassociationID = 56;  // int | 
            var ezsignfoldersignerassociationCreateEmbeddedUrlV1Request = new EzsignfoldersignerassociationCreateEmbeddedUrlV1Request(); // EzsignfoldersignerassociationCreateEmbeddedUrlV1Request | 

            try
            {
                // Creates an Url to allow embedded signing
                EzsignfoldersignerassociationCreateEmbeddedUrlV1Response result = apiInstance.EzsignfoldersignerassociationCreateEmbeddedUrlV1(pkiEzsignfoldersignerassociationID, ezsignfoldersignerassociationCreateEmbeddedUrlV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationCreateEmbeddedUrlV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfoldersignerassociationCreateEmbeddedUrlV1WithHttpInfo variant

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

try
{
    // Creates an Url to allow embedded signing
    ApiResponse<EzsignfoldersignerassociationCreateEmbeddedUrlV1Response> response = apiInstance.EzsignfoldersignerassociationCreateEmbeddedUrlV1WithHttpInfo(pkiEzsignfoldersignerassociationID, ezsignfoldersignerassociationCreateEmbeddedUrlV1Request);
    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 ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationCreateEmbeddedUrlV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignfoldersignerassociationID int
ezsignfoldersignerassociationCreateEmbeddedUrlV1Request EzsignfoldersignerassociationCreateEmbeddedUrlV1Request

Return type

EzsignfoldersignerassociationCreateEmbeddedUrlV1Response

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]

EzsignfoldersignerassociationCreateObjectV1

EzsignfoldersignerassociationCreateObjectV1Response EzsignfoldersignerassociationCreateObjectV1 (List ezsignfoldersignerassociationCreateObjectV1Request)

Create a new Ezsignfoldersignerassociation

The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects.

Example

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

namespace Example
{
    public class EzsignfoldersignerassociationCreateObjectV1Example
    {
        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 ObjectEzsignfoldersignerassociationApi(config);
            var ezsignfoldersignerassociationCreateObjectV1Request = new List<EzsignfoldersignerassociationCreateObjectV1Request>(); // List<EzsignfoldersignerassociationCreateObjectV1Request> | 

            try
            {
                // Create a new Ezsignfoldersignerassociation
                EzsignfoldersignerassociationCreateObjectV1Response result = apiInstance.EzsignfoldersignerassociationCreateObjectV1(ezsignfoldersignerassociationCreateObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationCreateObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfoldersignerassociationCreateObjectV1WithHttpInfo variant

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

try
{
    // Create a new Ezsignfoldersignerassociation
    ApiResponse<EzsignfoldersignerassociationCreateObjectV1Response> response = apiInstance.EzsignfoldersignerassociationCreateObjectV1WithHttpInfo(ezsignfoldersignerassociationCreateObjectV1Request);
    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 ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationCreateObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
ezsignfoldersignerassociationCreateObjectV1Request List<EzsignfoldersignerassociationCreateObjectV1Request>

Return type

EzsignfoldersignerassociationCreateObjectV1Response

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]

EzsignfoldersignerassociationCreateObjectV2

EzsignfoldersignerassociationCreateObjectV2Response EzsignfoldersignerassociationCreateObjectV2 (EzsignfoldersignerassociationCreateObjectV2Request ezsignfoldersignerassociationCreateObjectV2Request)

Create a new Ezsignfoldersignerassociation

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 EzsignfoldersignerassociationCreateObjectV2Example
    {
        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 ObjectEzsignfoldersignerassociationApi(config);
            var ezsignfoldersignerassociationCreateObjectV2Request = new EzsignfoldersignerassociationCreateObjectV2Request(); // EzsignfoldersignerassociationCreateObjectV2Request | 

            try
            {
                // Create a new Ezsignfoldersignerassociation
                EzsignfoldersignerassociationCreateObjectV2Response result = apiInstance.EzsignfoldersignerassociationCreateObjectV2(ezsignfoldersignerassociationCreateObjectV2Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationCreateObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfoldersignerassociationCreateObjectV2WithHttpInfo variant

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

try
{
    // Create a new Ezsignfoldersignerassociation
    ApiResponse<EzsignfoldersignerassociationCreateObjectV2Response> response = apiInstance.EzsignfoldersignerassociationCreateObjectV2WithHttpInfo(ezsignfoldersignerassociationCreateObjectV2Request);
    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 ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationCreateObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
ezsignfoldersignerassociationCreateObjectV2Request EzsignfoldersignerassociationCreateObjectV2Request

Return type

EzsignfoldersignerassociationCreateObjectV2Response

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]

EzsignfoldersignerassociationDeleteObjectV1

EzsignfoldersignerassociationDeleteObjectV1Response EzsignfoldersignerassociationDeleteObjectV1 (int pkiEzsignfoldersignerassociationID)

Delete an existing Ezsignfoldersignerassociation

Example

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

namespace Example
{
    public class EzsignfoldersignerassociationDeleteObjectV1Example
    {
        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 ObjectEzsignfoldersignerassociationApi(config);
            var pkiEzsignfoldersignerassociationID = 56;  // int | 

            try
            {
                // Delete an existing Ezsignfoldersignerassociation
                EzsignfoldersignerassociationDeleteObjectV1Response result = apiInstance.EzsignfoldersignerassociationDeleteObjectV1(pkiEzsignfoldersignerassociationID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationDeleteObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfoldersignerassociationDeleteObjectV1WithHttpInfo variant

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

try
{
    // Delete an existing Ezsignfoldersignerassociation
    ApiResponse<EzsignfoldersignerassociationDeleteObjectV1Response> response = apiInstance.EzsignfoldersignerassociationDeleteObjectV1WithHttpInfo(pkiEzsignfoldersignerassociationID);
    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 ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationDeleteObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignfoldersignerassociationID int

Return type

EzsignfoldersignerassociationDeleteObjectV1Response

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

EzsignfoldersignerassociationEditObjectV1

EzsignfoldersignerassociationEditObjectV1Response EzsignfoldersignerassociationEditObjectV1 (int pkiEzsignfoldersignerassociationID, EzsignfoldersignerassociationEditObjectV1Request ezsignfoldersignerassociationEditObjectV1Request)

Edit an existing Ezsignfoldersignerassociation

Example

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

namespace Example
{
    public class EzsignfoldersignerassociationEditObjectV1Example
    {
        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 ObjectEzsignfoldersignerassociationApi(config);
            var pkiEzsignfoldersignerassociationID = 56;  // int | 
            var ezsignfoldersignerassociationEditObjectV1Request = new EzsignfoldersignerassociationEditObjectV1Request(); // EzsignfoldersignerassociationEditObjectV1Request | 

            try
            {
                // Edit an existing Ezsignfoldersignerassociation
                EzsignfoldersignerassociationEditObjectV1Response result = apiInstance.EzsignfoldersignerassociationEditObjectV1(pkiEzsignfoldersignerassociationID, ezsignfoldersignerassociationEditObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationEditObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfoldersignerassociationEditObjectV1WithHttpInfo variant

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

try
{
    // Edit an existing Ezsignfoldersignerassociation
    ApiResponse<EzsignfoldersignerassociationEditObjectV1Response> response = apiInstance.EzsignfoldersignerassociationEditObjectV1WithHttpInfo(pkiEzsignfoldersignerassociationID, ezsignfoldersignerassociationEditObjectV1Request);
    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 ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationEditObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignfoldersignerassociationID int
ezsignfoldersignerassociationEditObjectV1Request EzsignfoldersignerassociationEditObjectV1Request

Return type

EzsignfoldersignerassociationEditObjectV1Response

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]

EzsignfoldersignerassociationForceDisconnectV1

EzsignfoldersignerassociationForceDisconnectV1Response EzsignfoldersignerassociationForceDisconnectV1 (int pkiEzsignfoldersignerassociationID, Object body)

Disconnects the Ezsignfoldersignerassociation

Example

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

namespace Example
{
    public class EzsignfoldersignerassociationForceDisconnectV1Example
    {
        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 ObjectEzsignfoldersignerassociationApi(config);
            var pkiEzsignfoldersignerassociationID = 56;  // int | 
            var body = null;  // Object | 

            try
            {
                // Disconnects the Ezsignfoldersignerassociation
                EzsignfoldersignerassociationForceDisconnectV1Response result = apiInstance.EzsignfoldersignerassociationForceDisconnectV1(pkiEzsignfoldersignerassociationID, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationForceDisconnectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfoldersignerassociationForceDisconnectV1WithHttpInfo variant

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

try
{
    // Disconnects the Ezsignfoldersignerassociation
    ApiResponse<EzsignfoldersignerassociationForceDisconnectV1Response> response = apiInstance.EzsignfoldersignerassociationForceDisconnectV1WithHttpInfo(pkiEzsignfoldersignerassociationID, body);
    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 ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationForceDisconnectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignfoldersignerassociationID int
body Object

Return type

EzsignfoldersignerassociationForceDisconnectV1Response

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]

EzsignfoldersignerassociationGetInPersonLoginUrlV1

EzsignfoldersignerassociationGetInPersonLoginUrlV1Response EzsignfoldersignerassociationGetInPersonLoginUrlV1 (int pkiEzsignfoldersignerassociationID)

Retrieve a Login Url to allow In-Person signing

This endpoint returns a Login Url that can be used in a browser or embedded in an I-Frame to allow in person signing. The signer Login type must be configured as In-Person.

Example

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

namespace Example
{
    public class EzsignfoldersignerassociationGetInPersonLoginUrlV1Example
    {
        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 ObjectEzsignfoldersignerassociationApi(config);
            var pkiEzsignfoldersignerassociationID = 56;  // int | 

            try
            {
                // Retrieve a Login Url to allow In-Person signing
                EzsignfoldersignerassociationGetInPersonLoginUrlV1Response result = apiInstance.EzsignfoldersignerassociationGetInPersonLoginUrlV1(pkiEzsignfoldersignerassociationID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationGetInPersonLoginUrlV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfoldersignerassociationGetInPersonLoginUrlV1WithHttpInfo variant

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

try
{
    // Retrieve a Login Url to allow In-Person signing
    ApiResponse<EzsignfoldersignerassociationGetInPersonLoginUrlV1Response> response = apiInstance.EzsignfoldersignerassociationGetInPersonLoginUrlV1WithHttpInfo(pkiEzsignfoldersignerassociationID);
    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 ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationGetInPersonLoginUrlV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignfoldersignerassociationID int

Return type

EzsignfoldersignerassociationGetInPersonLoginUrlV1Response

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

EzsignfoldersignerassociationGetObjectV1

EzsignfoldersignerassociationGetObjectV1Response EzsignfoldersignerassociationGetObjectV1 (int pkiEzsignfoldersignerassociationID)

Retrieve an existing Ezsignfoldersignerassociation

Example

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

namespace Example
{
    public class EzsignfoldersignerassociationGetObjectV1Example
    {
        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 ObjectEzsignfoldersignerassociationApi(config);
            var pkiEzsignfoldersignerassociationID = 56;  // int | 

            try
            {
                // Retrieve an existing Ezsignfoldersignerassociation
                EzsignfoldersignerassociationGetObjectV1Response result = apiInstance.EzsignfoldersignerassociationGetObjectV1(pkiEzsignfoldersignerassociationID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationGetObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfoldersignerassociationGetObjectV1WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignfoldersignerassociation
    ApiResponse<EzsignfoldersignerassociationGetObjectV1Response> response = apiInstance.EzsignfoldersignerassociationGetObjectV1WithHttpInfo(pkiEzsignfoldersignerassociationID);
    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 ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationGetObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignfoldersignerassociationID int

Return type

EzsignfoldersignerassociationGetObjectV1Response

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]

EzsignfoldersignerassociationGetObjectV2

EzsignfoldersignerassociationGetObjectV2Response EzsignfoldersignerassociationGetObjectV2 (int pkiEzsignfoldersignerassociationID)

Retrieve an existing Ezsignfoldersignerassociation

Example

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

namespace Example
{
    public class EzsignfoldersignerassociationGetObjectV2Example
    {
        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 ObjectEzsignfoldersignerassociationApi(config);
            var pkiEzsignfoldersignerassociationID = 56;  // int | 

            try
            {
                // Retrieve an existing Ezsignfoldersignerassociation
                EzsignfoldersignerassociationGetObjectV2Response result = apiInstance.EzsignfoldersignerassociationGetObjectV2(pkiEzsignfoldersignerassociationID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationGetObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfoldersignerassociationGetObjectV2WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignfoldersignerassociation
    ApiResponse<EzsignfoldersignerassociationGetObjectV2Response> response = apiInstance.EzsignfoldersignerassociationGetObjectV2WithHttpInfo(pkiEzsignfoldersignerassociationID);
    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 ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationGetObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignfoldersignerassociationID int

Return type

EzsignfoldersignerassociationGetObjectV2Response

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]

EzsignfoldersignerassociationPatchObjectV1

EzsignfoldersignerassociationPatchObjectV1Response EzsignfoldersignerassociationPatchObjectV1 (int pkiEzsignfoldersignerassociationID, EzsignfoldersignerassociationPatchObjectV1Request ezsignfoldersignerassociationPatchObjectV1Request)

Patch an existing Ezsignfoldersignerassociation

Example

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

namespace Example
{
    public class EzsignfoldersignerassociationPatchObjectV1Example
    {
        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 ObjectEzsignfoldersignerassociationApi(config);
            var pkiEzsignfoldersignerassociationID = 56;  // int | 
            var ezsignfoldersignerassociationPatchObjectV1Request = new EzsignfoldersignerassociationPatchObjectV1Request(); // EzsignfoldersignerassociationPatchObjectV1Request | 

            try
            {
                // Patch an existing Ezsignfoldersignerassociation
                EzsignfoldersignerassociationPatchObjectV1Response result = apiInstance.EzsignfoldersignerassociationPatchObjectV1(pkiEzsignfoldersignerassociationID, ezsignfoldersignerassociationPatchObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationPatchObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignfoldersignerassociationPatchObjectV1WithHttpInfo variant

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

try
{
    // Patch an existing Ezsignfoldersignerassociation
    ApiResponse<EzsignfoldersignerassociationPatchObjectV1Response> response = apiInstance.EzsignfoldersignerassociationPatchObjectV1WithHttpInfo(pkiEzsignfoldersignerassociationID, ezsignfoldersignerassociationPatchObjectV1Request);
    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 ObjectEzsignfoldersignerassociationApi.EzsignfoldersignerassociationPatchObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignfoldersignerassociationID int
ezsignfoldersignerassociationPatchObjectV1Request EzsignfoldersignerassociationPatchObjectV1Request

Return type

EzsignfoldersignerassociationPatchObjectV1Response

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]