Skip to content

Latest commit

 

History

History
391 lines (312 loc) · 14.1 KB

ObjectOtherincomeApi.md

File metadata and controls

391 lines (312 loc) · 14.1 KB

eZmaxApi.Api.ObjectOtherincomeApi

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

Method HTTP request Description
OtherincomeGetCommunicationCountV1 GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationCount Retrieve Communication count
OtherincomeGetCommunicationListV1 GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationList Retrieve Communication list
OtherincomeGetCommunicationrecipientsV1 GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationrecipients Retrieve Otherincome's Communicationrecipient
OtherincomeGetCommunicationsendersV1 GET /1/object/otherincome/{pkiOtherincomeID}/getCommunicationsenders Retrieve Otherincome's Communicationsender

OtherincomeGetCommunicationCountV1

OtherincomeGetCommunicationCountV1Response OtherincomeGetCommunicationCountV1 (int pkiOtherincomeID)

Retrieve Communication count

Example

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

namespace Example
{
    public class OtherincomeGetCommunicationCountV1Example
    {
        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 ObjectOtherincomeApi(config);
            var pkiOtherincomeID = 56;  // int | 

            try
            {
                // Retrieve Communication count
                OtherincomeGetCommunicationCountV1Response result = apiInstance.OtherincomeGetCommunicationCountV1(pkiOtherincomeID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectOtherincomeApi.OtherincomeGetCommunicationCountV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the OtherincomeGetCommunicationCountV1WithHttpInfo variant

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

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

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

OtherincomeGetCommunicationCountV1Response

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]

OtherincomeGetCommunicationListV1

OtherincomeGetCommunicationListV1Response OtherincomeGetCommunicationListV1 (int pkiOtherincomeID)

Retrieve Communication list

Example

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

namespace Example
{
    public class OtherincomeGetCommunicationListV1Example
    {
        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 ObjectOtherincomeApi(config);
            var pkiOtherincomeID = 56;  // int | 

            try
            {
                // Retrieve Communication list
                OtherincomeGetCommunicationListV1Response result = apiInstance.OtherincomeGetCommunicationListV1(pkiOtherincomeID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectOtherincomeApi.OtherincomeGetCommunicationListV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the OtherincomeGetCommunicationListV1WithHttpInfo variant

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

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

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

OtherincomeGetCommunicationListV1Response

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]

OtherincomeGetCommunicationrecipientsV1

OtherincomeGetCommunicationrecipientsV1Response OtherincomeGetCommunicationrecipientsV1 (int pkiOtherincomeID)

Retrieve Otherincome's Communicationrecipient

Example

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

namespace Example
{
    public class OtherincomeGetCommunicationrecipientsV1Example
    {
        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 ObjectOtherincomeApi(config);
            var pkiOtherincomeID = 56;  // int | 

            try
            {
                // Retrieve Otherincome's Communicationrecipient
                OtherincomeGetCommunicationrecipientsV1Response result = apiInstance.OtherincomeGetCommunicationrecipientsV1(pkiOtherincomeID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectOtherincomeApi.OtherincomeGetCommunicationrecipientsV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the OtherincomeGetCommunicationrecipientsV1WithHttpInfo variant

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

try
{
    // Retrieve Otherincome's Communicationrecipient
    ApiResponse<OtherincomeGetCommunicationrecipientsV1Response> response = apiInstance.OtherincomeGetCommunicationrecipientsV1WithHttpInfo(pkiOtherincomeID);
    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 ObjectOtherincomeApi.OtherincomeGetCommunicationrecipientsV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

OtherincomeGetCommunicationrecipientsV1Response

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]

OtherincomeGetCommunicationsendersV1

OtherincomeGetCommunicationsendersV1Response OtherincomeGetCommunicationsendersV1 (int pkiOtherincomeID)

Retrieve Otherincome's Communicationsender

Example

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

namespace Example
{
    public class OtherincomeGetCommunicationsendersV1Example
    {
        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 ObjectOtherincomeApi(config);
            var pkiOtherincomeID = 56;  // int | 

            try
            {
                // Retrieve Otherincome's Communicationsender
                OtherincomeGetCommunicationsendersV1Response result = apiInstance.OtherincomeGetCommunicationsendersV1(pkiOtherincomeID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectOtherincomeApi.OtherincomeGetCommunicationsendersV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the OtherincomeGetCommunicationsendersV1WithHttpInfo variant

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

try
{
    // Retrieve Otherincome's Communicationsender
    ApiResponse<OtherincomeGetCommunicationsendersV1Response> response = apiInstance.OtherincomeGetCommunicationsendersV1WithHttpInfo(pkiOtherincomeID);
    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 ObjectOtherincomeApi.OtherincomeGetCommunicationsendersV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
pkiOtherincomeID int

Return type

OtherincomeGetCommunicationsendersV1Response

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]