All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
Method | HTTP request | Description |
---|---|---|
EzsignsignatureCreateObjectV1 | POST /1/object/ezsignsignature | Create a new Ezsignsignature |
EzsignsignatureCreateObjectV2 | POST /2/object/ezsignsignature | Create a new Ezsignsignature |
EzsignsignatureDeleteObjectV1 | DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID} | Delete an existing Ezsignsignature |
EzsignsignatureEditObjectV1 | PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} | Edit an existing Ezsignsignature |
EzsignsignatureGetEzsignsignatureattachmentV1 | GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment | Retrieve an existing Ezsignsignature's Ezsignsignatureattachments |
EzsignsignatureGetEzsignsignaturesAutomaticV1 | GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic | Retrieve all automatic Ezsignsignatures |
EzsignsignatureGetObjectV2 | GET /2/object/ezsignsignature/{pkiEzsignsignatureID} | Retrieve an existing Ezsignsignature |
EzsignsignatureSignV1 | POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign | Sign the Ezsignsignature |
EzsignsignatureCreateObjectV1Response EzsignsignatureCreateObjectV1 (List ezsignsignatureCreateObjectV1Request)
Create a new Ezsignsignature
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.
using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;
namespace Example
{
public class EzsignsignatureCreateObjectV1Example
{
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 ObjectEzsignsignatureApi(config);
var ezsignsignatureCreateObjectV1Request = new List<EzsignsignatureCreateObjectV1Request>(); // List<EzsignsignatureCreateObjectV1Request> |
try
{
// Create a new Ezsignsignature
EzsignsignatureCreateObjectV1Response result = apiInstance.EzsignsignatureCreateObjectV1(ezsignsignatureCreateObjectV1Request);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ObjectEzsignsignatureApi.EzsignsignatureCreateObjectV1: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Create a new Ezsignsignature
ApiResponse<EzsignsignatureCreateObjectV1Response> response = apiInstance.EzsignsignatureCreateObjectV1WithHttpInfo(ezsignsignatureCreateObjectV1Request);
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 ObjectEzsignsignatureApi.EzsignsignatureCreateObjectV1WithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
ezsignsignatureCreateObjectV1Request | List<EzsignsignatureCreateObjectV1Request> |
EzsignsignatureCreateObjectV1Response
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | Successful response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsignsignatureCreateObjectV2Response EzsignsignatureCreateObjectV2 (EzsignsignatureCreateObjectV2Request ezsignsignatureCreateObjectV2Request)
Create a new Ezsignsignature
The endpoint allows to create one or many elements at once.
using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;
namespace Example
{
public class EzsignsignatureCreateObjectV2Example
{
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 ObjectEzsignsignatureApi(config);
var ezsignsignatureCreateObjectV2Request = new EzsignsignatureCreateObjectV2Request(); // EzsignsignatureCreateObjectV2Request |
try
{
// Create a new Ezsignsignature
EzsignsignatureCreateObjectV2Response result = apiInstance.EzsignsignatureCreateObjectV2(ezsignsignatureCreateObjectV2Request);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ObjectEzsignsignatureApi.EzsignsignatureCreateObjectV2: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Create a new Ezsignsignature
ApiResponse<EzsignsignatureCreateObjectV2Response> response = apiInstance.EzsignsignatureCreateObjectV2WithHttpInfo(ezsignsignatureCreateObjectV2Request);
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 ObjectEzsignsignatureApi.EzsignsignatureCreateObjectV2WithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
ezsignsignatureCreateObjectV2Request | EzsignsignatureCreateObjectV2Request |
EzsignsignatureCreateObjectV2Response
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | Successful response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsignsignatureDeleteObjectV1Response EzsignsignatureDeleteObjectV1 (int pkiEzsignsignatureID)
Delete an existing Ezsignsignature
using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;
namespace Example
{
public class EzsignsignatureDeleteObjectV1Example
{
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 ObjectEzsignsignatureApi(config);
var pkiEzsignsignatureID = 56; // int |
try
{
// Delete an existing Ezsignsignature
EzsignsignatureDeleteObjectV1Response result = apiInstance.EzsignsignatureDeleteObjectV1(pkiEzsignsignatureID);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ObjectEzsignsignatureApi.EzsignsignatureDeleteObjectV1: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Delete an existing Ezsignsignature
ApiResponse<EzsignsignatureDeleteObjectV1Response> response = apiInstance.EzsignsignatureDeleteObjectV1WithHttpInfo(pkiEzsignsignatureID);
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 ObjectEzsignsignatureApi.EzsignsignatureDeleteObjectV1WithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
pkiEzsignsignatureID | int |
EzsignsignatureDeleteObjectV1Response
- Content-Type: Not defined
- Accept: application/json
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]
EzsignsignatureEditObjectV1Response EzsignsignatureEditObjectV1 (int pkiEzsignsignatureID, EzsignsignatureEditObjectV1Request ezsignsignatureEditObjectV1Request)
Edit an existing Ezsignsignature
using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;
namespace Example
{
public class EzsignsignatureEditObjectV1Example
{
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 ObjectEzsignsignatureApi(config);
var pkiEzsignsignatureID = 56; // int |
var ezsignsignatureEditObjectV1Request = new EzsignsignatureEditObjectV1Request(); // EzsignsignatureEditObjectV1Request |
try
{
// Edit an existing Ezsignsignature
EzsignsignatureEditObjectV1Response result = apiInstance.EzsignsignatureEditObjectV1(pkiEzsignsignatureID, ezsignsignatureEditObjectV1Request);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ObjectEzsignsignatureApi.EzsignsignatureEditObjectV1: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Edit an existing Ezsignsignature
ApiResponse<EzsignsignatureEditObjectV1Response> response = apiInstance.EzsignsignatureEditObjectV1WithHttpInfo(pkiEzsignsignatureID, ezsignsignatureEditObjectV1Request);
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 ObjectEzsignsignatureApi.EzsignsignatureEditObjectV1WithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
pkiEzsignsignatureID | int | ||
ezsignsignatureEditObjectV1Request | EzsignsignatureEditObjectV1Request |
EzsignsignatureEditObjectV1Response
- Content-Type: application/json
- Accept: application/json
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]
EzsignsignatureGetEzsignsignatureattachmentV1Response EzsignsignatureGetEzsignsignatureattachmentV1 (int pkiEzsignsignatureID)
Retrieve an existing Ezsignsignature's Ezsignsignatureattachments
using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;
namespace Example
{
public class EzsignsignatureGetEzsignsignatureattachmentV1Example
{
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 ObjectEzsignsignatureApi(config);
var pkiEzsignsignatureID = 56; // int |
try
{
// Retrieve an existing Ezsignsignature's Ezsignsignatureattachments
EzsignsignatureGetEzsignsignatureattachmentV1Response result = apiInstance.EzsignsignatureGetEzsignsignatureattachmentV1(pkiEzsignsignatureID);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ObjectEzsignsignatureApi.EzsignsignatureGetEzsignsignatureattachmentV1: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Retrieve an existing Ezsignsignature's Ezsignsignatureattachments
ApiResponse<EzsignsignatureGetEzsignsignatureattachmentV1Response> response = apiInstance.EzsignsignatureGetEzsignsignatureattachmentV1WithHttpInfo(pkiEzsignsignatureID);
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 ObjectEzsignsignatureApi.EzsignsignatureGetEzsignsignatureattachmentV1WithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
pkiEzsignsignatureID | int |
EzsignsignatureGetEzsignsignatureattachmentV1Response
- Content-Type: Not defined
- Accept: application/json
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]
EzsignsignatureGetEzsignsignaturesAutomaticV1Response EzsignsignatureGetEzsignsignaturesAutomaticV1 ()
Retrieve all automatic Ezsignsignatures
Return all the Ezsignsignatures that can be signed by the current user
using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;
namespace Example
{
public class EzsignsignatureGetEzsignsignaturesAutomaticV1Example
{
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 ObjectEzsignsignatureApi(config);
try
{
// Retrieve all automatic Ezsignsignatures
EzsignsignatureGetEzsignsignaturesAutomaticV1Response result = apiInstance.EzsignsignatureGetEzsignsignaturesAutomaticV1();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ObjectEzsignsignatureApi.EzsignsignatureGetEzsignsignaturesAutomaticV1: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Retrieve all automatic Ezsignsignatures
ApiResponse<EzsignsignatureGetEzsignsignaturesAutomaticV1Response> response = apiInstance.EzsignsignatureGetEzsignsignaturesAutomaticV1WithHttpInfo();
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 ObjectEzsignsignatureApi.EzsignsignatureGetEzsignsignaturesAutomaticV1WithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
This endpoint does not need any parameter.
EzsignsignatureGetEzsignsignaturesAutomaticV1Response
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | Successful response | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EzsignsignatureGetObjectV2Response EzsignsignatureGetObjectV2 (int pkiEzsignsignatureID)
Retrieve an existing Ezsignsignature
using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;
namespace Example
{
public class EzsignsignatureGetObjectV2Example
{
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 ObjectEzsignsignatureApi(config);
var pkiEzsignsignatureID = 56; // int |
try
{
// Retrieve an existing Ezsignsignature
EzsignsignatureGetObjectV2Response result = apiInstance.EzsignsignatureGetObjectV2(pkiEzsignsignatureID);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ObjectEzsignsignatureApi.EzsignsignatureGetObjectV2: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Retrieve an existing Ezsignsignature
ApiResponse<EzsignsignatureGetObjectV2Response> response = apiInstance.EzsignsignatureGetObjectV2WithHttpInfo(pkiEzsignsignatureID);
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 ObjectEzsignsignatureApi.EzsignsignatureGetObjectV2WithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
pkiEzsignsignatureID | int |
EzsignsignatureGetObjectV2Response
- Content-Type: Not defined
- Accept: application/json
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]
EzsignsignatureSignV1Response EzsignsignatureSignV1 (int pkiEzsignsignatureID, EzsignsignatureSignV1Request ezsignsignatureSignV1Request)
Sign the Ezsignsignature
using System.Collections.Generic;
using System.Diagnostics;
using eZmaxApi.Api;
using eZmaxApi.Client;
using eZmaxApi.Model;
namespace Example
{
public class EzsignsignatureSignV1Example
{
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 ObjectEzsignsignatureApi(config);
var pkiEzsignsignatureID = 56; // int |
var ezsignsignatureSignV1Request = new EzsignsignatureSignV1Request(); // EzsignsignatureSignV1Request |
try
{
// Sign the Ezsignsignature
EzsignsignatureSignV1Response result = apiInstance.EzsignsignatureSignV1(pkiEzsignsignatureID, ezsignsignatureSignV1Request);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ObjectEzsignsignatureApi.EzsignsignatureSignV1: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
This returns an ApiResponse object which contains the response data, status code and headers.
try
{
// Sign the Ezsignsignature
ApiResponse<EzsignsignatureSignV1Response> response = apiInstance.EzsignsignatureSignV1WithHttpInfo(pkiEzsignsignatureID, ezsignsignatureSignV1Request);
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 ObjectEzsignsignatureApi.EzsignsignatureSignV1WithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
Name | Type | Description | Notes |
---|---|---|---|
pkiEzsignsignatureID | int | ||
ezsignsignatureSignV1Request | EzsignsignatureSignV1Request |
- Content-Type: application/json
- Accept: application/json
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]