Skip to content

Latest commit

 

History

History
391 lines (312 loc) · 14.3 KB

ObjectTranqcontractApi.md

File metadata and controls

391 lines (312 loc) · 14.3 KB

eZmaxApi.Api.ObjectTranqcontractApi

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

Method HTTP request Description
TranqcontractGetCommunicationCountV1 GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationCount Retrieve Communication count
TranqcontractGetCommunicationListV1 GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationList Retrieve Communication list
TranqcontractGetCommunicationrecipientsV1 GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationrecipients Retrieve Tranqcontract's Communicationrecipient
TranqcontractGetCommunicationsendersV1 GET /1/object/tranqcontract/{pkiTranqcontractID}/getCommunicationsenders Retrieve Tranqcontract's Communicationsender

TranqcontractGetCommunicationCountV1

TranqcontractGetCommunicationCountV1Response TranqcontractGetCommunicationCountV1 (int pkiTranqcontractID)

Retrieve Communication count

Example

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

namespace Example
{
    public class TranqcontractGetCommunicationCountV1Example
    {
        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 ObjectTranqcontractApi(config);
            var pkiTranqcontractID = 56;  // int | 

            try
            {
                // Retrieve Communication count
                TranqcontractGetCommunicationCountV1Response result = apiInstance.TranqcontractGetCommunicationCountV1(pkiTranqcontractID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectTranqcontractApi.TranqcontractGetCommunicationCountV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the TranqcontractGetCommunicationCountV1WithHttpInfo variant

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

try
{
    // Retrieve Communication count
    ApiResponse<TranqcontractGetCommunicationCountV1Response> response = apiInstance.TranqcontractGetCommunicationCountV1WithHttpInfo(pkiTranqcontractID);
    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 ObjectTranqcontractApi.TranqcontractGetCommunicationCountV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiTranqcontractID int

Return type

TranqcontractGetCommunicationCountV1Response

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]

TranqcontractGetCommunicationListV1

TranqcontractGetCommunicationListV1Response TranqcontractGetCommunicationListV1 (int pkiTranqcontractID)

Retrieve Communication list

Example

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

namespace Example
{
    public class TranqcontractGetCommunicationListV1Example
    {
        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 ObjectTranqcontractApi(config);
            var pkiTranqcontractID = 56;  // int | 

            try
            {
                // Retrieve Communication list
                TranqcontractGetCommunicationListV1Response result = apiInstance.TranqcontractGetCommunicationListV1(pkiTranqcontractID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectTranqcontractApi.TranqcontractGetCommunicationListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the TranqcontractGetCommunicationListV1WithHttpInfo variant

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

try
{
    // Retrieve Communication list
    ApiResponse<TranqcontractGetCommunicationListV1Response> response = apiInstance.TranqcontractGetCommunicationListV1WithHttpInfo(pkiTranqcontractID);
    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 ObjectTranqcontractApi.TranqcontractGetCommunicationListV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiTranqcontractID int

Return type

TranqcontractGetCommunicationListV1Response

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]

TranqcontractGetCommunicationrecipientsV1

TranqcontractGetCommunicationrecipientsV1Response TranqcontractGetCommunicationrecipientsV1 (int pkiTranqcontractID)

Retrieve Tranqcontract's Communicationrecipient

Example

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

namespace Example
{
    public class TranqcontractGetCommunicationrecipientsV1Example
    {
        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 ObjectTranqcontractApi(config);
            var pkiTranqcontractID = 56;  // int | 

            try
            {
                // Retrieve Tranqcontract's Communicationrecipient
                TranqcontractGetCommunicationrecipientsV1Response result = apiInstance.TranqcontractGetCommunicationrecipientsV1(pkiTranqcontractID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectTranqcontractApi.TranqcontractGetCommunicationrecipientsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the TranqcontractGetCommunicationrecipientsV1WithHttpInfo variant

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

try
{
    // Retrieve Tranqcontract's Communicationrecipient
    ApiResponse<TranqcontractGetCommunicationrecipientsV1Response> response = apiInstance.TranqcontractGetCommunicationrecipientsV1WithHttpInfo(pkiTranqcontractID);
    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 ObjectTranqcontractApi.TranqcontractGetCommunicationrecipientsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiTranqcontractID int

Return type

TranqcontractGetCommunicationrecipientsV1Response

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]

TranqcontractGetCommunicationsendersV1

TranqcontractGetCommunicationsendersV1Response TranqcontractGetCommunicationsendersV1 (int pkiTranqcontractID)

Retrieve Tranqcontract's Communicationsender

Example

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

namespace Example
{
    public class TranqcontractGetCommunicationsendersV1Example
    {
        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 ObjectTranqcontractApi(config);
            var pkiTranqcontractID = 56;  // int | 

            try
            {
                // Retrieve Tranqcontract's Communicationsender
                TranqcontractGetCommunicationsendersV1Response result = apiInstance.TranqcontractGetCommunicationsendersV1(pkiTranqcontractID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectTranqcontractApi.TranqcontractGetCommunicationsendersV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the TranqcontractGetCommunicationsendersV1WithHttpInfo variant

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

try
{
    // Retrieve Tranqcontract's Communicationsender
    ApiResponse<TranqcontractGetCommunicationsendersV1Response> response = apiInstance.TranqcontractGetCommunicationsendersV1WithHttpInfo(pkiTranqcontractID);
    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 ObjectTranqcontractApi.TranqcontractGetCommunicationsendersV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiTranqcontractID int

Return type

TranqcontractGetCommunicationsendersV1Response

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]