Skip to content

Latest commit

 

History

History
120 lines (81 loc) · 4.04 KB

ModuleEzsignApi.md

File metadata and controls

120 lines (81 loc) · 4.04 KB

ModuleEzsignApi

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

Method HTTP request Description
ezsignSuggestSignersV1 GET /1/module/ezsign/suggestSigners Suggest signers
ezsignSuggestTemplatesV1 GET /1/module/ezsign/suggestTemplates Suggest templates

ezsignSuggestSignersV1

-(NSURLSessionTask*) ezsignSuggestSignersV1WithCompletionHandler: 
        (void (^)(EzsignSuggestSignersV1Response* output, NSError* error)) handler;

Suggest signers

Retrieve previously used Ezsignsigners and all users from the system

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



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

// Suggest signers
[apiInstance ezsignSuggestSignersV1WithCompletionHandler: 
          ^(EzsignSuggestSignersV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ModuleEzsignApi->ezsignSuggestSignersV1: %@", error);
                        }
                    }];

Parameters

This endpoint does not need any parameter.

Return type

EzsignSuggestSignersV1Response*

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]

ezsignSuggestTemplatesV1

-(NSURLSessionTask*) ezsignSuggestTemplatesV1WithFkiEzsignfoldertypeID: (NSNumber*) fkiEzsignfoldertypeID
        completionHandler: (void (^)(EzsignSuggestTemplatesV1Response* output, NSError* error)) handler;

Suggest templates

Retrieve Ezsigntemplates and Ezsigntemplatepackages that can be imported in a Ezsignfolder

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* fkiEzsignfoldertypeID = @56; //  (optional)

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

// Suggest templates
[apiInstance ezsignSuggestTemplatesV1WithFkiEzsignfoldertypeID:fkiEzsignfoldertypeID
          completionHandler: ^(EzsignSuggestTemplatesV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ModuleEzsignApi->ezsignSuggestTemplatesV1: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
fkiEzsignfoldertypeID NSNumber* [optional]

Return type

EzsignSuggestTemplatesV1Response*

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]