Skip to content

Latest commit

 

History

History
157 lines (104 loc) · 5.12 KB

ObjectInscriptionApi.md

File metadata and controls

157 lines (104 loc) · 5.12 KB

openapi.api.ObjectInscriptionApi

Load the API package

import 'package:openapi/api.dart';

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

Method HTTP request Description
inscriptionGetAttachmentsV1 GET /1/object/inscription/{pkiInscriptionID}/getAttachments Retrieve Inscription's Attachments
inscriptionGetCommunicationListV1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList Retrieve Communication list
inscriptionGetCommunicationsendersV1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationsenders Retrieve Inscription's Communicationsender

inscriptionGetAttachmentsV1

InscriptionGetAttachmentsV1Response inscriptionGetAttachmentsV1(pkiInscriptionID)

Retrieve Inscription's Attachments

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectInscriptionApi();
final pkiInscriptionID = 56; // int | 

try {
    final result = api_instance.inscriptionGetAttachmentsV1(pkiInscriptionID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectInscriptionApi->inscriptionGetAttachmentsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiInscriptionID int

Return type

InscriptionGetAttachmentsV1Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inscriptionGetCommunicationListV1

InscriptionGetCommunicationListV1Response inscriptionGetCommunicationListV1(pkiInscriptionID)

Retrieve Communication list

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectInscriptionApi();
final pkiInscriptionID = 56; // int | 

try {
    final result = api_instance.inscriptionGetCommunicationListV1(pkiInscriptionID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectInscriptionApi->inscriptionGetCommunicationListV1: $e\n');
}

Parameters

Name Type Description Notes
pkiInscriptionID int

Return type

InscriptionGetCommunicationListV1Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

inscriptionGetCommunicationsendersV1

InscriptionGetCommunicationsendersV1Response inscriptionGetCommunicationsendersV1(pkiInscriptionID)

Retrieve Inscription's Communicationsender

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectInscriptionApi();
final pkiInscriptionID = 56; // int | 

try {
    final result = api_instance.inscriptionGetCommunicationsendersV1(pkiInscriptionID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectInscriptionApi->inscriptionGetCommunicationsendersV1: $e\n');
}

Parameters

Name Type Description Notes
pkiInscriptionID int

Return type

InscriptionGetCommunicationsendersV1Response

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]