ObjectEzsigntemplateApi

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

Method	HTTP request	Description
ezsigntemplateCopyV1	POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy	Copy the Ezsigntemplate
ezsigntemplateCreateObjectV1	POST /1/object/ezsigntemplate	Create a new Ezsigntemplate
ezsigntemplateCreateObjectV2	POST /2/object/ezsigntemplate	Create a new Ezsigntemplate
ezsigntemplateDeleteObjectV1	DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID}	Delete an existing Ezsigntemplate
ezsigntemplateEditObjectV1	PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID}	Edit an existing Ezsigntemplate
ezsigntemplateEditObjectV2	PUT /2/object/ezsigntemplate/{pkiEzsigntemplateID}	Edit an existing Ezsigntemplate
ezsigntemplateGetAutocompleteV2	GET /2/object/ezsigntemplate/getAutocomplete/{sSelector}	Retrieve Ezsigntemplates and IDs
ezsigntemplateGetListV1	GET /1/object/ezsigntemplate/getList	Retrieve Ezsigntemplate list
ezsigntemplateGetObjectV1	GET /1/object/ezsigntemplate/{pkiEzsigntemplateID}	Retrieve an existing Ezsigntemplate
ezsigntemplateGetObjectV2	GET /2/object/ezsigntemplate/{pkiEzsigntemplateID}	Retrieve an existing Ezsigntemplate

ezsigntemplateCopyV1

-(NSURLSessionTask*) ezsigntemplateCopyV1WithPkiEzsigntemplateID: (NSNumber*) pkiEzsigntemplateID
    ezsigntemplateCopyV1Request: (EzsigntemplateCopyV1Request*) ezsigntemplateCopyV1Request
        completionHandler: (void (^)(EzsigntemplateCopyV1Response* output, NSError* error)) handler;

Copy the Ezsigntemplate

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* pkiEzsigntemplateID = @56; // 
EzsigntemplateCopyV1Request* ezsigntemplateCopyV1Request = [[EzsigntemplateCopyV1Request alloc] init]; // 

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

// Copy the Ezsigntemplate
[apiInstance ezsigntemplateCopyV1WithPkiEzsigntemplateID:pkiEzsigntemplateID
              ezsigntemplateCopyV1Request:ezsigntemplateCopyV1Request
          completionHandler: ^(EzsigntemplateCopyV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigntemplateApi->ezsigntemplateCopyV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigntemplateID	NSNumber*
ezsigntemplateCopyV1Request	EzsigntemplateCopyV1Request*

Return type

EzsigntemplateCopyV1Response*

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

ezsigntemplateCreateObjectV1

-(NSURLSessionTask*) ezsigntemplateCreateObjectV1WithEzsigntemplateCreateObjectV1Request: (EzsigntemplateCreateObjectV1Request*) ezsigntemplateCreateObjectV1Request
        completionHandler: (void (^)(EzsigntemplateCreateObjectV1Response* output, NSError* error)) handler;

Create a new Ezsigntemplate

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

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


EzsigntemplateCreateObjectV1Request* ezsigntemplateCreateObjectV1Request = [[EzsigntemplateCreateObjectV1Request alloc] init]; // 

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

// Create a new Ezsigntemplate
[apiInstance ezsigntemplateCreateObjectV1WithEzsigntemplateCreateObjectV1Request:ezsigntemplateCreateObjectV1Request
          completionHandler: ^(EzsigntemplateCreateObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigntemplateApi->ezsigntemplateCreateObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
ezsigntemplateCreateObjectV1Request	EzsigntemplateCreateObjectV1Request*

Return type

EzsigntemplateCreateObjectV1Response*

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

ezsigntemplateCreateObjectV2

-(NSURLSessionTask*) ezsigntemplateCreateObjectV2WithEzsigntemplateCreateObjectV2Request: (EzsigntemplateCreateObjectV2Request*) ezsigntemplateCreateObjectV2Request
        completionHandler: (void (^)(EzsigntemplateCreateObjectV2Response* output, NSError* error)) handler;

Create a new Ezsigntemplate

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

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


EzsigntemplateCreateObjectV2Request* ezsigntemplateCreateObjectV2Request = [[EzsigntemplateCreateObjectV2Request alloc] init]; // 

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

// Create a new Ezsigntemplate
[apiInstance ezsigntemplateCreateObjectV2WithEzsigntemplateCreateObjectV2Request:ezsigntemplateCreateObjectV2Request
          completionHandler: ^(EzsigntemplateCreateObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigntemplateApi->ezsigntemplateCreateObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
ezsigntemplateCreateObjectV2Request	EzsigntemplateCreateObjectV2Request*

Return type

EzsigntemplateCreateObjectV2Response*

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

ezsigntemplateDeleteObjectV1

-(NSURLSessionTask*) ezsigntemplateDeleteObjectV1WithPkiEzsigntemplateID: (NSNumber*) pkiEzsigntemplateID
        completionHandler: (void (^)(EzsigntemplateDeleteObjectV1Response* output, NSError* error)) handler;

Delete an existing Ezsigntemplate

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* pkiEzsigntemplateID = @56; // 

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

// Delete an existing Ezsigntemplate
[apiInstance ezsigntemplateDeleteObjectV1WithPkiEzsigntemplateID:pkiEzsigntemplateID
          completionHandler: ^(EzsigntemplateDeleteObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigntemplateApi->ezsigntemplateDeleteObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigntemplateID	NSNumber*

Return type

EzsigntemplateDeleteObjectV1Response*

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]

ezsigntemplateEditObjectV1

-(NSURLSessionTask*) ezsigntemplateEditObjectV1WithPkiEzsigntemplateID: (NSNumber*) pkiEzsigntemplateID
    ezsigntemplateEditObjectV1Request: (EzsigntemplateEditObjectV1Request*) ezsigntemplateEditObjectV1Request
        completionHandler: (void (^)(EzsigntemplateEditObjectV1Response* output, NSError* error)) handler;

Edit an existing Ezsigntemplate

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* pkiEzsigntemplateID = @56; // 
EzsigntemplateEditObjectV1Request* ezsigntemplateEditObjectV1Request = [[EzsigntemplateEditObjectV1Request alloc] init]; // 

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

// Edit an existing Ezsigntemplate
[apiInstance ezsigntemplateEditObjectV1WithPkiEzsigntemplateID:pkiEzsigntemplateID
              ezsigntemplateEditObjectV1Request:ezsigntemplateEditObjectV1Request
          completionHandler: ^(EzsigntemplateEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigntemplateApi->ezsigntemplateEditObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigntemplateID	NSNumber*
ezsigntemplateEditObjectV1Request	EzsigntemplateEditObjectV1Request*

Return type

EzsigntemplateEditObjectV1Response*

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

ezsigntemplateEditObjectV2

-(NSURLSessionTask*) ezsigntemplateEditObjectV2WithPkiEzsigntemplateID: (NSNumber*) pkiEzsigntemplateID
    ezsigntemplateEditObjectV2Request: (EzsigntemplateEditObjectV2Request*) ezsigntemplateEditObjectV2Request
        completionHandler: (void (^)(EzsigntemplateEditObjectV2Response* output, NSError* error)) handler;

Edit an existing Ezsigntemplate

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* pkiEzsigntemplateID = @56; // 
EzsigntemplateEditObjectV2Request* ezsigntemplateEditObjectV2Request = [[EzsigntemplateEditObjectV2Request alloc] init]; // 

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

// Edit an existing Ezsigntemplate
[apiInstance ezsigntemplateEditObjectV2WithPkiEzsigntemplateID:pkiEzsigntemplateID
              ezsigntemplateEditObjectV2Request:ezsigntemplateEditObjectV2Request
          completionHandler: ^(EzsigntemplateEditObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigntemplateApi->ezsigntemplateEditObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigntemplateID	NSNumber*
ezsigntemplateEditObjectV2Request	EzsigntemplateEditObjectV2Request*

Return type

EzsigntemplateEditObjectV2Response*

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

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

ezsigntemplateGetAutocompleteV2

-(NSURLSessionTask*) ezsigntemplateGetAutocompleteV2WithSSelector: (NSString*) sSelector
    eFilterActive: (NSString*) eFilterActive
    sQuery: (NSString*) sQuery
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
        completionHandler: (void (^)(EzsigntemplateGetAutocompleteV2Response* output, NSError* error)) handler;

Retrieve Ezsigntemplates and IDs

Get the list of Ezsigntemplate to be used in a dropdown or autocomplete control.

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


NSString* sSelector = @"sSelector_example"; // The type of Ezsigntemplates to return
NSString* eFilterActive = @"Active"; // Specify which results we want to display. (optional) (default to @"Active")
NSString* sQuery = @"sQuery_example"; // Allow to filter the returned results (optional)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; //  (optional)

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

// Retrieve Ezsigntemplates and IDs
[apiInstance ezsigntemplateGetAutocompleteV2WithSSelector:sSelector
              eFilterActive:eFilterActive
              sQuery:sQuery
              acceptLanguage:acceptLanguage
          completionHandler: ^(EzsigntemplateGetAutocompleteV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigntemplateApi->ezsigntemplateGetAutocompleteV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
sSelector	NSString*	The type of Ezsigntemplates to return
eFilterActive	NSString*	Specify which results we want to display.	[optional] [default to @"Active"]
sQuery	NSString*	Allow to filter the returned results	[optional]
acceptLanguage	HeaderAcceptLanguage		[optional]

Return type

EzsigntemplateGetAutocompleteV2Response*

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]

ezsigntemplateGetListV1

-(NSURLSessionTask*) ezsigntemplateGetListV1WithEOrderBy: (NSString*) eOrderBy
    iRowMax: (NSNumber*) iRowMax
    iRowOffset: (NSNumber*) iRowOffset
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
    sFilter: (NSString*) sFilter
        completionHandler: (void (^)(EzsigntemplateGetListV1Response* output, NSError* error)) handler;

Retrieve Ezsigntemplate list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsigntemplateType | Company
Team
User
Usergroup |

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


NSString* eOrderBy = @"eOrderBy_example"; // Specify how you want the results to be sorted (optional)
NSNumber* iRowMax = @56; //  (optional)
NSNumber* iRowOffset = @0; //  (optional) (default to @0)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; //  (optional)
NSString* sFilter = @"sFilter_example"; //  (optional)

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

// Retrieve Ezsigntemplate list
[apiInstance ezsigntemplateGetListV1WithEOrderBy:eOrderBy
              iRowMax:iRowMax
              iRowOffset:iRowOffset
              acceptLanguage:acceptLanguage
              sFilter:sFilter
          completionHandler: ^(EzsigntemplateGetListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigntemplateApi->ezsigntemplateGetListV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
eOrderBy	NSString*	Specify how you want the results to be sorted	[optional]
iRowMax	NSNumber*		[optional]
iRowOffset	NSNumber*		[optional] [default to @0]
acceptLanguage	HeaderAcceptLanguage		[optional]
sFilter	NSString*		[optional]

Return type

EzsigntemplateGetListV1Response*

Authorization

HTTP request headers

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

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

ezsigntemplateGetObjectV1

-(NSURLSessionTask*) ezsigntemplateGetObjectV1WithPkiEzsigntemplateID: (NSNumber*) pkiEzsigntemplateID
        completionHandler: (void (^)(EzsigntemplateGetObjectV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsigntemplate

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* pkiEzsigntemplateID = @56; // 

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

// Retrieve an existing Ezsigntemplate
[apiInstance ezsigntemplateGetObjectV1WithPkiEzsigntemplateID:pkiEzsigntemplateID
          completionHandler: ^(EzsigntemplateGetObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigntemplateApi->ezsigntemplateGetObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigntemplateID	NSNumber*

Return type

EzsigntemplateGetObjectV1Response*

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]

ezsigntemplateGetObjectV2

-(NSURLSessionTask*) ezsigntemplateGetObjectV2WithPkiEzsigntemplateID: (NSNumber*) pkiEzsigntemplateID
        completionHandler: (void (^)(EzsigntemplateGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing Ezsigntemplate

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* pkiEzsigntemplateID = @56; // 

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

// Retrieve an existing Ezsigntemplate
[apiInstance ezsigntemplateGetObjectV2WithPkiEzsigntemplateID:pkiEzsigntemplateID
          completionHandler: ^(EzsigntemplateGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsigntemplateApi->ezsigntemplateGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsigntemplateID	NSNumber*

Return type

EzsigntemplateGetObjectV2Response*

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]

Files

ObjectEzsigntemplateApi.md

Latest commit

History

ObjectEzsigntemplateApi.md

File metadata and controls

ObjectEzsigntemplateApi

ezsigntemplateCopyV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateCreateObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateCreateObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateDeleteObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateEditObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateEditObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateGetAutocompleteV2

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateGetListV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateGetObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsigntemplateGetObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers