Skip to content

Files

Latest commit

 

History

History
298 lines (199 loc) · 10.9 KB

ObjectInscriptionApi.md

File metadata and controls

298 lines (199 loc) · 10.9 KB

ObjectInscriptionApi

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
inscriptionGetCommunicationCountV1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationCount Retrieve Communication count
inscriptionGetCommunicationListV1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationList Retrieve Communication list
inscriptionGetCommunicationrecipientsV1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationrecipients Retrieve Inscription's Communicationrecipient
inscriptionGetCommunicationsendersV1 GET /1/object/inscription/{pkiInscriptionID}/getCommunicationsenders Retrieve Inscription's Communicationsender

inscriptionGetAttachmentsV1

-(NSURLSessionTask*) inscriptionGetAttachmentsV1WithPkiInscriptionID: (NSNumber*) pkiInscriptionID
        completionHandler: (void (^)(InscriptionGetAttachmentsV1Response* output, NSError* error)) handler;

Retrieve Inscription's Attachments

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiInscriptionID = @56; // 

ObjectInscriptionApi*apiInstance = [[ObjectInscriptionApi alloc] init];

// Retrieve Inscription's Attachments
[apiInstance inscriptionGetAttachmentsV1WithPkiInscriptionID:pkiInscriptionID
          completionHandler: ^(InscriptionGetAttachmentsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectInscriptionApi->inscriptionGetAttachmentsV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiInscriptionID NSNumber*

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]

inscriptionGetCommunicationCountV1

-(NSURLSessionTask*) inscriptionGetCommunicationCountV1WithPkiInscriptionID: (NSNumber*) pkiInscriptionID
        completionHandler: (void (^)(InscriptionGetCommunicationCountV1Response* output, NSError* error)) handler;

Retrieve Communication count

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiInscriptionID = @56; // 

ObjectInscriptionApi*apiInstance = [[ObjectInscriptionApi alloc] init];

// Retrieve Communication count
[apiInstance inscriptionGetCommunicationCountV1WithPkiInscriptionID:pkiInscriptionID
          completionHandler: ^(InscriptionGetCommunicationCountV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectInscriptionApi->inscriptionGetCommunicationCountV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiInscriptionID NSNumber*

Return type

InscriptionGetCommunicationCountV1Response*

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

-(NSURLSessionTask*) inscriptionGetCommunicationListV1WithPkiInscriptionID: (NSNumber*) pkiInscriptionID
        completionHandler: (void (^)(InscriptionGetCommunicationListV1Response* output, NSError* error)) handler;

Retrieve Communication list

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiInscriptionID = @56; // 

ObjectInscriptionApi*apiInstance = [[ObjectInscriptionApi alloc] init];

// Retrieve Communication list
[apiInstance inscriptionGetCommunicationListV1WithPkiInscriptionID:pkiInscriptionID
          completionHandler: ^(InscriptionGetCommunicationListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectInscriptionApi->inscriptionGetCommunicationListV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiInscriptionID NSNumber*

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]

inscriptionGetCommunicationrecipientsV1

-(NSURLSessionTask*) inscriptionGetCommunicationrecipientsV1WithPkiInscriptionID: (NSNumber*) pkiInscriptionID
        completionHandler: (void (^)(InscriptionGetCommunicationrecipientsV1Response* output, NSError* error)) handler;

Retrieve Inscription's Communicationrecipient

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiInscriptionID = @56; // 

ObjectInscriptionApi*apiInstance = [[ObjectInscriptionApi alloc] init];

// Retrieve Inscription's Communicationrecipient
[apiInstance inscriptionGetCommunicationrecipientsV1WithPkiInscriptionID:pkiInscriptionID
          completionHandler: ^(InscriptionGetCommunicationrecipientsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectInscriptionApi->inscriptionGetCommunicationrecipientsV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiInscriptionID NSNumber*

Return type

InscriptionGetCommunicationrecipientsV1Response*

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

-(NSURLSessionTask*) inscriptionGetCommunicationsendersV1WithPkiInscriptionID: (NSNumber*) pkiInscriptionID
        completionHandler: (void (^)(InscriptionGetCommunicationsendersV1Response* output, NSError* error)) handler;

Retrieve Inscription's Communicationsender

Example

DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];


NSNumber* pkiInscriptionID = @56; // 

ObjectInscriptionApi*apiInstance = [[ObjectInscriptionApi alloc] init];

// Retrieve Inscription's Communicationsender
[apiInstance inscriptionGetCommunicationsendersV1WithPkiInscriptionID:pkiInscriptionID
          completionHandler: ^(InscriptionGetCommunicationsendersV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectInscriptionApi->inscriptionGetCommunicationsendersV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
pkiInscriptionID NSNumber*

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]