ObjectCommunicationApi.md

eZmaxApi.Api.ObjectCommunicationApi

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

Method	HTTP request	Description
CommunicationSendV1	POST /1/object/communication/send	Send a new Communication

CommunicationSendV1

CommunicationSendV1Response CommunicationSendV1 (CommunicationSendV1Request communicationSendV1Request)

Send a new Communication

The endpoint allows to send 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 CommunicationSendV1Example
    {
        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 ObjectCommunicationApi(config);
            var communicationSendV1Request = new CommunicationSendV1Request(); // CommunicationSendV1Request | 

            try
            {
                // Send a new Communication
                CommunicationSendV1Response result = apiInstance.CommunicationSendV1(communicationSendV1Request);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling ObjectCommunicationApi.CommunicationSendV1: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the CommunicationSendV1WithHttpInfo variant

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

try
{
    // Send a new Communication
    ApiResponse<CommunicationSendV1Response> response = apiInstance.CommunicationSendV1WithHttpInfo(communicationSendV1Request);
    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 ObjectCommunicationApi.CommunicationSendV1WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
communicationSendV1Request	CommunicationSendV1Request

Return type

CommunicationSendV1Response

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]