Skip to content

Latest commit

 

History

History
296 lines (235 loc) · 11.8 KB

ObjectEzsignsignergroupmembershipApi.md

File metadata and controls

296 lines (235 loc) · 11.8 KB

eZmaxApi.Api.ObjectEzsignsignergroupmembershipApi

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

Method HTTP request Description
EzsignsignergroupmembershipCreateObjectV1 POST /1/object/ezsignsignergroupmembership Create a new Ezsignsignergroupmembership
EzsignsignergroupmembershipDeleteObjectV1 DELETE /1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} Delete an existing Ezsignsignergroupmembership
EzsignsignergroupmembershipGetObjectV2 GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID} Retrieve an existing Ezsignsignergroupmembership

EzsignsignergroupmembershipCreateObjectV1

EzsignsignergroupmembershipCreateObjectV1Response EzsignsignergroupmembershipCreateObjectV1 (EzsignsignergroupmembershipCreateObjectV1Request ezsignsignergroupmembershipCreateObjectV1Request)

Create a new Ezsignsignergroupmembership

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 EzsignsignergroupmembershipCreateObjectV1Example
    {
        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 ObjectEzsignsignergroupmembershipApi(config);
            var ezsignsignergroupmembershipCreateObjectV1Request = new EzsignsignergroupmembershipCreateObjectV1Request(); // EzsignsignergroupmembershipCreateObjectV1Request | 

            try
            {
                // Create a new Ezsignsignergroupmembership
                EzsignsignergroupmembershipCreateObjectV1Response result = apiInstance.EzsignsignergroupmembershipCreateObjectV1(ezsignsignergroupmembershipCreateObjectV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignsignergroupmembershipApi.EzsignsignergroupmembershipCreateObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignsignergroupmembershipCreateObjectV1WithHttpInfo variant

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

try
{
    // Create a new Ezsignsignergroupmembership
    ApiResponse<EzsignsignergroupmembershipCreateObjectV1Response> response = apiInstance.EzsignsignergroupmembershipCreateObjectV1WithHttpInfo(ezsignsignergroupmembershipCreateObjectV1Request);
    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 ObjectEzsignsignergroupmembershipApi.EzsignsignergroupmembershipCreateObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
ezsignsignergroupmembershipCreateObjectV1Request EzsignsignergroupmembershipCreateObjectV1Request

Return type

EzsignsignergroupmembershipCreateObjectV1Response

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]

EzsignsignergroupmembershipDeleteObjectV1

EzsignsignergroupmembershipDeleteObjectV1Response EzsignsignergroupmembershipDeleteObjectV1 (int pkiEzsignsignergroupmembershipID)

Delete an existing Ezsignsignergroupmembership

Example

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

namespace Example
{
    public class EzsignsignergroupmembershipDeleteObjectV1Example
    {
        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 ObjectEzsignsignergroupmembershipApi(config);
            var pkiEzsignsignergroupmembershipID = 56;  // int | The unique ID of the Ezsignsignergroupmembership

            try
            {
                // Delete an existing Ezsignsignergroupmembership
                EzsignsignergroupmembershipDeleteObjectV1Response result = apiInstance.EzsignsignergroupmembershipDeleteObjectV1(pkiEzsignsignergroupmembershipID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignsignergroupmembershipApi.EzsignsignergroupmembershipDeleteObjectV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignsignergroupmembershipDeleteObjectV1WithHttpInfo variant

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

try
{
    // Delete an existing Ezsignsignergroupmembership
    ApiResponse<EzsignsignergroupmembershipDeleteObjectV1Response> response = apiInstance.EzsignsignergroupmembershipDeleteObjectV1WithHttpInfo(pkiEzsignsignergroupmembershipID);
    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 ObjectEzsignsignergroupmembershipApi.EzsignsignergroupmembershipDeleteObjectV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignsignergroupmembershipID int The unique ID of the Ezsignsignergroupmembership

Return type

EzsignsignergroupmembershipDeleteObjectV1Response

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]

EzsignsignergroupmembershipGetObjectV2

EzsignsignergroupmembershipGetObjectV2Response EzsignsignergroupmembershipGetObjectV2 (int pkiEzsignsignergroupmembershipID)

Retrieve an existing Ezsignsignergroupmembership

Example

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

namespace Example
{
    public class EzsignsignergroupmembershipGetObjectV2Example
    {
        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 ObjectEzsignsignergroupmembershipApi(config);
            var pkiEzsignsignergroupmembershipID = 56;  // int | The unique ID of the Ezsignsignergroupmembership

            try
            {
                // Retrieve an existing Ezsignsignergroupmembership
                EzsignsignergroupmembershipGetObjectV2Response result = apiInstance.EzsignsignergroupmembershipGetObjectV2(pkiEzsignsignergroupmembershipID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectEzsignsignergroupmembershipApi.EzsignsignergroupmembershipGetObjectV2: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the EzsignsignergroupmembershipGetObjectV2WithHttpInfo variant

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

try
{
    // Retrieve an existing Ezsignsignergroupmembership
    ApiResponse<EzsignsignergroupmembershipGetObjectV2Response> response = apiInstance.EzsignsignergroupmembershipGetObjectV2WithHttpInfo(pkiEzsignsignergroupmembershipID);
    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 ObjectEzsignsignergroupmembershipApi.EzsignsignergroupmembershipGetObjectV2WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiEzsignsignergroupmembershipID int The unique ID of the Ezsignsignergroupmembership

Return type

EzsignsignergroupmembershipGetObjectV2Response

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]