Skip to content

ObjectCommunicationApi.md

Latest commit

 

History

History
148 lines (112 loc) · 5.12 KB

ObjectCommunicationApi.md

File metadata and controls

148 lines (112 loc) · 5.12 KB

ObjectCommunicationApi

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

Method HTTP request Description
communicationGetCommunicationBodyV1 GET /1/object/communication/{pkiCommunicationID}/getCommunicationBody Retrieve the communication body
communicationSendV1 POST /1/object/communication/send Send a new Communication

communicationGetCommunicationBodyV1

communicationGetCommunicationBodyV1(pkiCommunicationID)

Retrieve the communication body

This endpoint returns the communication body.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectCommunicationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectCommunicationApi apiInstance = new ObjectCommunicationApi(defaultClient);
    Integer pkiCommunicationID = 56; // Integer | 
    try {
      apiInstance.communicationGetCommunicationBodyV1(pkiCommunicationID);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectCommunicationApi#communicationGetCommunicationBodyV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
pkiCommunicationID Integer

Return type

null (empty response body)

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
302 The user has been redirected -
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 -

communicationSendV1

CommunicationSendV1Response communicationSendV1(communicationSendV1Request)

Send a new Communication

The endpoint allows to send one or many elements at once.

Example

// Import classes:
import eZmaxAPI.ApiClient;
import eZmaxAPI.ApiException;
import eZmaxAPI.Configuration;
import eZmaxAPI.auth.*;
import eZmaxAPI.models.*;
import com.ezmax.api.ObjectCommunicationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
    
    // Configure API key authorization: Authorization
    ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
    Authorization.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Authorization.setApiKeyPrefix("Token");

    ObjectCommunicationApi apiInstance = new ObjectCommunicationApi(defaultClient);
    CommunicationSendV1Request communicationSendV1Request = new CommunicationSendV1Request(); // CommunicationSendV1Request | 
    try {
      CommunicationSendV1Response result = apiInstance.communicationSendV1(communicationSendV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectCommunicationApi#communicationSendV1");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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 -