ObjectInscriptiontempApi

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

Method	HTTP request	Description
inscriptiontempGetCommunicationCountV1	GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationCount	Retrieve Communication count
inscriptiontempGetCommunicationListV1	GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationList	Retrieve Communication list
inscriptiontempGetCommunicationrecipientsV1	GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationrecipients	Retrieve Inscriptiontemp's Communicationrecipient
inscriptiontempGetCommunicationsendersV1	GET /1/object/inscriptiontemp/{pkiInscriptiontempID}/getCommunicationsenders	Retrieve Inscriptiontemp's Communicationsender
inscriptiontempGetListV1	GET /1/object/inscriptiontemp/getList	Retrieve Inscriptiontemp list
inscriptiontempImportIntoEDMV1	POST /1/object/inscriptiontemp/{pkiInscriptiontempID}/importIntoEDM	Import attachments into the Inscriptiontemp

inscriptiontempGetCommunicationCountV1

InscriptiontempGetCommunicationCountV1Response inscriptiontempGetCommunicationCountV1(pkiInscriptiontempID)

Retrieve Communication count

Example

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

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");

    ObjectInscriptiontempApi apiInstance = new ObjectInscriptiontempApi(defaultClient);
    Integer pkiInscriptiontempID = 56; // Integer | 
    try {
      InscriptiontempGetCommunicationCountV1Response result = apiInstance.inscriptiontempGetCommunicationCountV1(pkiInscriptiontempID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInscriptiontempApi#inscriptiontempGetCommunicationCountV1");
      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
pkiInscriptiontempID	Integer

Return type

InscriptiontempGetCommunicationCountV1Response

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	-

inscriptiontempGetCommunicationListV1

InscriptiontempGetCommunicationListV1Response inscriptiontempGetCommunicationListV1(pkiInscriptiontempID)

Retrieve Communication list

Example

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

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");

    ObjectInscriptiontempApi apiInstance = new ObjectInscriptiontempApi(defaultClient);
    Integer pkiInscriptiontempID = 56; // Integer | 
    try {
      InscriptiontempGetCommunicationListV1Response result = apiInstance.inscriptiontempGetCommunicationListV1(pkiInscriptiontempID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInscriptiontempApi#inscriptiontempGetCommunicationListV1");
      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
pkiInscriptiontempID	Integer

Return type

InscriptiontempGetCommunicationListV1Response

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	-

inscriptiontempGetCommunicationrecipientsV1

InscriptiontempGetCommunicationrecipientsV1Response inscriptiontempGetCommunicationrecipientsV1(pkiInscriptiontempID)

Retrieve Inscriptiontemp's Communicationrecipient

Example

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

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");

    ObjectInscriptiontempApi apiInstance = new ObjectInscriptiontempApi(defaultClient);
    Integer pkiInscriptiontempID = 56; // Integer | 
    try {
      InscriptiontempGetCommunicationrecipientsV1Response result = apiInstance.inscriptiontempGetCommunicationrecipientsV1(pkiInscriptiontempID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInscriptiontempApi#inscriptiontempGetCommunicationrecipientsV1");
      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
pkiInscriptiontempID	Integer

Return type

InscriptiontempGetCommunicationrecipientsV1Response

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	-

inscriptiontempGetCommunicationsendersV1

InscriptiontempGetCommunicationsendersV1Response inscriptiontempGetCommunicationsendersV1(pkiInscriptiontempID)

Retrieve Inscriptiontemp's Communicationsender

Example

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

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");

    ObjectInscriptiontempApi apiInstance = new ObjectInscriptiontempApi(defaultClient);
    Integer pkiInscriptiontempID = 56; // Integer | 
    try {
      InscriptiontempGetCommunicationsendersV1Response result = apiInstance.inscriptiontempGetCommunicationsendersV1(pkiInscriptiontempID);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInscriptiontempApi#inscriptiontempGetCommunicationsendersV1");
      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
pkiInscriptiontempID	Integer

Return type

InscriptiontempGetCommunicationsendersV1Response

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	-

inscriptiontempGetListV1

InscriptiontempGetListV1Response inscriptiontempGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Inscriptiontemp list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eInscriptiontempStatus | Imported<br>Processed<br>Modified |

Example

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

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");

    ObjectInscriptiontempApi apiInstance = new ObjectInscriptiontempApi(defaultClient);
    String eOrderBy = "pkiInscriptiontempID_ASC"; // String | Specify how you want the results to be sorted
    Integer iRowMax = 56; // Integer | 
    Integer iRowOffset = 0; // Integer | 
    HeaderAcceptLanguage acceptLanguage = HeaderAcceptLanguage.fromValue("*"); // HeaderAcceptLanguage | 
    String sFilter = "sFilter_example"; // String | 
    try {
      InscriptiontempGetListV1Response result = apiInstance.inscriptiontempGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInscriptiontempApi#inscriptiontempGetListV1");
      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
eOrderBy	String	Specify how you want the results to be sorted	[optional] [enum: pkiInscriptiontempID_ASC, pkiInscriptiontempID_DESC, eInscriptiontempStatus_ASC, eInscriptiontempStatus_DESC, sInscriptiontempMLS_ASC, sInscriptiontempMLS_DESC, sInscriptiontempDescription_ASC, sInscriptiontempDescription_DESC, bInscriptiontempIsactive_ASC, bInscriptiontempIsactive_DESC, dtCreatedDate_ASC, dtCreatedDate_DESC, dtModifiedDate_ASC, dtModifiedDate_DESC]
iRowMax	Integer		[optional]
iRowOffset	Integer		[optional] [default to 0]
acceptLanguage	HeaderAcceptLanguage		[optional] [enum: *, en, fr]
sFilter	String		[optional]

Return type

InscriptiontempGetListV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

HTTP response details

Status code	Description	Response headers
200	Successful response	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-

inscriptiontempImportIntoEDMV1

InscriptiontempImportIntoEDMV1Response inscriptiontempImportIntoEDMV1(pkiInscriptiontempID, inscriptiontempImportIntoEDMV1Request)

Import attachments into the Inscriptiontemp

Example

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

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");

    ObjectInscriptiontempApi apiInstance = new ObjectInscriptiontempApi(defaultClient);
    Integer pkiInscriptiontempID = 56; // Integer | 
    InscriptiontempImportIntoEDMV1Request inscriptiontempImportIntoEDMV1Request = new InscriptiontempImportIntoEDMV1Request(); // InscriptiontempImportIntoEDMV1Request | 
    try {
      InscriptiontempImportIntoEDMV1Response result = apiInstance.inscriptiontempImportIntoEDMV1(pkiInscriptiontempID, inscriptiontempImportIntoEDMV1Request);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ObjectInscriptiontempApi#inscriptiontempImportIntoEDMV1");
      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
pkiInscriptiontempID	Integer
inscriptiontempImportIntoEDMV1Request	InscriptiontempImportIntoEDMV1Request

Return type

InscriptiontempImportIntoEDMV1Response

Authorization

HTTP request headers

Content-Type: application/json
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	-

FilesExpand file tree

ObjectInscriptiontempApi.md

Latest commit

History

ObjectInscriptiontempApi.md

File metadata and controls

ObjectInscriptiontempApi

inscriptiontempGetCommunicationCountV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inscriptiontempGetCommunicationListV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inscriptiontempGetCommunicationrecipientsV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inscriptiontempGetCommunicationsendersV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inscriptiontempGetListV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inscriptiontempImportIntoEDMV1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details