Skip to content

Latest commit

 

History

History
391 lines (312 loc) · 14.3 KB

ObjectBuyercontractApi.md

File metadata and controls

391 lines (312 loc) · 14.3 KB

eZmaxApi.Api.ObjectBuyercontractApi

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

Method HTTP request Description
BuyercontractGetCommunicationCountV1 GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationCount Retrieve Communication count
BuyercontractGetCommunicationListV1 GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationList Retrieve Communication list
BuyercontractGetCommunicationrecipientsV1 GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationrecipients Retrieve Buyercontract's Communicationrecipient
BuyercontractGetCommunicationsendersV1 GET /1/object/buyercontract/{pkiBuyercontractID}/getCommunicationsenders Retrieve Buyercontract's Communicationsender

BuyercontractGetCommunicationCountV1

BuyercontractGetCommunicationCountV1Response BuyercontractGetCommunicationCountV1 (int pkiBuyercontractID)

Retrieve Communication count

Example

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

namespace Example
{
    public class BuyercontractGetCommunicationCountV1Example
    {
        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 ObjectBuyercontractApi(config);
            var pkiBuyercontractID = 56;  // int | 

            try
            {
                // Retrieve Communication count
                BuyercontractGetCommunicationCountV1Response result = apiInstance.BuyercontractGetCommunicationCountV1(pkiBuyercontractID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectBuyercontractApi.BuyercontractGetCommunicationCountV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the BuyercontractGetCommunicationCountV1WithHttpInfo variant

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

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

Parameters

Name Type Description Notes
pkiBuyercontractID int

Return type

BuyercontractGetCommunicationCountV1Response

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]

BuyercontractGetCommunicationListV1

BuyercontractGetCommunicationListV1Response BuyercontractGetCommunicationListV1 (int pkiBuyercontractID)

Retrieve Communication list

Example

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

namespace Example
{
    public class BuyercontractGetCommunicationListV1Example
    {
        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 ObjectBuyercontractApi(config);
            var pkiBuyercontractID = 56;  // int | 

            try
            {
                // Retrieve Communication list
                BuyercontractGetCommunicationListV1Response result = apiInstance.BuyercontractGetCommunicationListV1(pkiBuyercontractID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectBuyercontractApi.BuyercontractGetCommunicationListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the BuyercontractGetCommunicationListV1WithHttpInfo variant

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

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

Parameters

Name Type Description Notes
pkiBuyercontractID int

Return type

BuyercontractGetCommunicationListV1Response

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]

BuyercontractGetCommunicationrecipientsV1

BuyercontractGetCommunicationrecipientsV1Response BuyercontractGetCommunicationrecipientsV1 (int pkiBuyercontractID)

Retrieve Buyercontract's Communicationrecipient

Example

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

namespace Example
{
    public class BuyercontractGetCommunicationrecipientsV1Example
    {
        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 ObjectBuyercontractApi(config);
            var pkiBuyercontractID = 56;  // int | 

            try
            {
                // Retrieve Buyercontract's Communicationrecipient
                BuyercontractGetCommunicationrecipientsV1Response result = apiInstance.BuyercontractGetCommunicationrecipientsV1(pkiBuyercontractID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectBuyercontractApi.BuyercontractGetCommunicationrecipientsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the BuyercontractGetCommunicationrecipientsV1WithHttpInfo variant

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

try
{
    // Retrieve Buyercontract's Communicationrecipient
    ApiResponse<BuyercontractGetCommunicationrecipientsV1Response> response = apiInstance.BuyercontractGetCommunicationrecipientsV1WithHttpInfo(pkiBuyercontractID);
    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 ObjectBuyercontractApi.BuyercontractGetCommunicationrecipientsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiBuyercontractID int

Return type

BuyercontractGetCommunicationrecipientsV1Response

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]

BuyercontractGetCommunicationsendersV1

BuyercontractGetCommunicationsendersV1Response BuyercontractGetCommunicationsendersV1 (int pkiBuyercontractID)

Retrieve Buyercontract's Communicationsender

Example

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

namespace Example
{
    public class BuyercontractGetCommunicationsendersV1Example
    {
        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 ObjectBuyercontractApi(config);
            var pkiBuyercontractID = 56;  // int | 

            try
            {
                // Retrieve Buyercontract's Communicationsender
                BuyercontractGetCommunicationsendersV1Response result = apiInstance.BuyercontractGetCommunicationsendersV1(pkiBuyercontractID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectBuyercontractApi.BuyercontractGetCommunicationsendersV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the BuyercontractGetCommunicationsendersV1WithHttpInfo variant

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

try
{
    // Retrieve Buyercontract's Communicationsender
    ApiResponse<BuyercontractGetCommunicationsendersV1Response> response = apiInstance.BuyercontractGetCommunicationsendersV1WithHttpInfo(pkiBuyercontractID);
    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 ObjectBuyercontractApi.BuyercontractGetCommunicationsendersV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiBuyercontractID int

Return type

BuyercontractGetCommunicationsendersV1Response

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]