Skip to content

Latest commit

 

History

History
106 lines (84 loc) · 3.58 KB

ObjectEzsignpageApi.md

File metadata and controls

106 lines (84 loc) · 3.58 KB

eZmaxApi.Api.ObjectEzsignpageApi

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

Method HTTP request Description
EzsignpageConsultV1 POST /1/object/ezsignpage/{pkiEzsignpageID}/consult Consult an Ezsignpage

EzsignpageConsultV1

EzsignpageConsultV1Response EzsignpageConsultV1 (int pkiEzsignpageID, Object body)

Consult an Ezsignpage

Example

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

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

            try
            {
                // Consult an Ezsignpage
                EzsignpageConsultV1Response result = apiInstance.EzsignpageConsultV1(pkiEzsignpageID, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignpageApi.EzsignpageConsultV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignpageConsultV1WithHttpInfo variant

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

try
{
    // Consult an Ezsignpage
    ApiResponse<EzsignpageConsultV1Response> response = apiInstance.EzsignpageConsultV1WithHttpInfo(pkiEzsignpageID, 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 ObjectEzsignpageApi.EzsignpageConsultV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignpageID int
body Object

Return type

EzsignpageConsultV1Response

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]