ObjectEzsignfolderApi

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

Method	HTTP request	Description
ezsignfolderArchiveV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive	Archive the Ezsignfolder
ezsignfolderBatchDownloadV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload	Download multiples files from an Ezsignfolder
ezsignfolderCreateObjectV1	POST /1/object/ezsignfolder	Create a new Ezsignfolder
ezsignfolderCreateObjectV2	POST /2/object/ezsignfolder	Create a new Ezsignfolder
ezsignfolderDeleteObjectV1	DELETE /1/object/ezsignfolder/{pkiEzsignfolderID}	Delete an existing Ezsignfolder
ezsignfolderDisposeEzsignfoldersV1	POST /1/object/ezsignfolder/disposeEzsignfolders	Dispose Ezsignfolders
ezsignfolderDisposeV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose	Dispose the Ezsignfolder
ezsignfolderEditObjectV1	PUT /1/object/ezsignfolder/{pkiEzsignfolderID}	Edit an existing Ezsignfolder
ezsignfolderEndPrematurelyV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/endPrematurely	End prematurely
ezsignfolderGetActionableElementsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements	Retrieve actionable elements for the Ezsignfolder
ezsignfolderGetAttachmentCountV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachmentCount	Retrieve Attachment count
ezsignfolderGetAttachmentsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getAttachments	Retrieve Ezsignfolder's Attachments
ezsignfolderGetCommunicationCountV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount	Retrieve Communication count
ezsignfolderGetCommunicationListV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList	Retrieve Communication list
ezsignfolderGetCommunicationrecipientsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationrecipients	Retrieve Ezsignfolder's Communicationrecipient
ezsignfolderGetCommunicationsendersV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationsenders	Retrieve Ezsignfolder's Communicationsender
ezsignfolderGetEzsigndocumentsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments	Retrieve an existing Ezsignfolder's Ezsigndocuments
ezsignfolderGetEzsignfoldersignerassociationsV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations	Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
ezsignfolderGetEzsignsignaturesAutomaticV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic	Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
ezsignfolderGetFormsDataV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData	Retrieve an existing Ezsignfolder's forms data
ezsignfolderGetListV1	GET /1/object/ezsignfolder/getList	Retrieve Ezsignfolder list
ezsignfolderGetObjectV1	GET /1/object/ezsignfolder/{pkiEzsignfolderID}	Retrieve an existing Ezsignfolder
ezsignfolderGetObjectV2	GET /2/object/ezsignfolder/{pkiEzsignfolderID}	Retrieve an existing Ezsignfolder
ezsignfolderImportEzsignfoldersignerassociationsV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations	Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
ezsignfolderImportEzsigntemplatepackageV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage	Import an Ezsigntemplatepackage in the Ezsignfolder.
ezsignfolderReorderV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder	Reorder Ezsigndocuments in the Ezsignfolder
ezsignfolderSendV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send	Send the Ezsignfolder to the signatories for signature
ezsignfolderSendV3	POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send	Send the Ezsignfolder to the signatories for signature
ezsignfolderUnsendV1	POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend	Unsend the Ezsignfolder

ezsignfolderArchiveV1

-(NSURLSessionTask*) ezsignfolderArchiveV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    body: (NSObject*) body
        completionHandler: (void (^)(EzsignfolderArchiveV1Response* output, NSError* error)) handler;

Archive the 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* pkiEzsignfolderID = @56; // 
NSObject* body = NULL; // 

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

// Archive the Ezsignfolder
[apiInstance ezsignfolderArchiveV1WithPkiEzsignfolderID:pkiEzsignfolderID
              body:body
          completionHandler: ^(EzsignfolderArchiveV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderArchiveV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
body	NSObject*

Return type

EzsignfolderArchiveV1Response*

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]

ezsignfolderBatchDownloadV1

-(NSURLSessionTask*) ezsignfolderBatchDownloadV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    ezsignfolderBatchDownloadV1Request: (EzsignfolderBatchDownloadV1Request*) ezsignfolderBatchDownloadV1Request
        completionHandler: (void (^)(NSURL* output, NSError* error)) handler;

Download multiples files from an 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* pkiEzsignfolderID = @56; // 
EzsignfolderBatchDownloadV1Request* ezsignfolderBatchDownloadV1Request = [[EzsignfolderBatchDownloadV1Request alloc] init]; // 

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

// Download multiples files from an Ezsignfolder
[apiInstance ezsignfolderBatchDownloadV1WithPkiEzsignfolderID:pkiEzsignfolderID
              ezsignfolderBatchDownloadV1Request:ezsignfolderBatchDownloadV1Request
          completionHandler: ^(NSURL* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderBatchDownloadV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
ezsignfolderBatchDownloadV1Request	EzsignfolderBatchDownloadV1Request*

Return type

NSURL*

Authorization

HTTP request headers

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

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

ezsignfolderCreateObjectV1

-(NSURLSessionTask*) ezsignfolderCreateObjectV1WithEzsignfolderCreateObjectV1Request: (NSArray<EzsignfolderCreateObjectV1Request>*) ezsignfolderCreateObjectV1Request
        completionHandler: (void (^)(EzsignfolderCreateObjectV1Response* output, NSError* error)) handler;

Create a new Ezsignfolder

The endpoint allows to create one or many elements at once. The array can contain simple (Just the object) or compound (The object and its child) objects. Creating compound elements allows to reduce the multiple requests to create all child objects.

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


NSArray<EzsignfolderCreateObjectV1Request>* ezsignfolderCreateObjectV1Request = @[[[EzsignfolderCreateObjectV1Request alloc] init]]; // 

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

// Create a new Ezsignfolder
[apiInstance ezsignfolderCreateObjectV1WithEzsignfolderCreateObjectV1Request:ezsignfolderCreateObjectV1Request
          completionHandler: ^(EzsignfolderCreateObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderCreateObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
ezsignfolderCreateObjectV1Request	NSArray<EzsignfolderCreateObjectV1Request>*

Return type

EzsignfolderCreateObjectV1Response*

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]

ezsignfolderCreateObjectV2

-(NSURLSessionTask*) ezsignfolderCreateObjectV2WithEzsignfolderCreateObjectV2Request: (EzsignfolderCreateObjectV2Request*) ezsignfolderCreateObjectV2Request
        completionHandler: (void (^)(EzsignfolderCreateObjectV2Response* output, NSError* error)) handler;

Create a new Ezsignfolder

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


EzsignfolderCreateObjectV2Request* ezsignfolderCreateObjectV2Request = [[EzsignfolderCreateObjectV2Request alloc] init]; // 

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

// Create a new Ezsignfolder
[apiInstance ezsignfolderCreateObjectV2WithEzsignfolderCreateObjectV2Request:ezsignfolderCreateObjectV2Request
          completionHandler: ^(EzsignfolderCreateObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderCreateObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
ezsignfolderCreateObjectV2Request	EzsignfolderCreateObjectV2Request*

Return type

EzsignfolderCreateObjectV2Response*

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]

ezsignfolderDeleteObjectV1

-(NSURLSessionTask*) ezsignfolderDeleteObjectV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderDeleteObjectV1Response* output, NSError* error)) handler;

Delete an existing 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* pkiEzsignfolderID = @56; // 

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

// Delete an existing Ezsignfolder
[apiInstance ezsignfolderDeleteObjectV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderDeleteObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderDeleteObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderDeleteObjectV1Response*

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]

ezsignfolderDisposeEzsignfoldersV1

-(NSURLSessionTask*) ezsignfolderDisposeEzsignfoldersV1WithEzsignfolderDisposeEzsignfoldersV1Request: (EzsignfolderDisposeEzsignfoldersV1Request*) ezsignfolderDisposeEzsignfoldersV1Request
        completionHandler: (void (^)(EzsignfolderDisposeEzsignfoldersV1Response* output, NSError* error)) handler;

Dispose Ezsignfolders

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


EzsignfolderDisposeEzsignfoldersV1Request* ezsignfolderDisposeEzsignfoldersV1Request = [[EzsignfolderDisposeEzsignfoldersV1Request alloc] init]; // 

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

// Dispose Ezsignfolders
[apiInstance ezsignfolderDisposeEzsignfoldersV1WithEzsignfolderDisposeEzsignfoldersV1Request:ezsignfolderDisposeEzsignfoldersV1Request
          completionHandler: ^(EzsignfolderDisposeEzsignfoldersV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderDisposeEzsignfoldersV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
ezsignfolderDisposeEzsignfoldersV1Request	EzsignfolderDisposeEzsignfoldersV1Request*

Return type

EzsignfolderDisposeEzsignfoldersV1Response*

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]

ezsignfolderDisposeV1

-(NSURLSessionTask*) ezsignfolderDisposeV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    body: (NSObject*) body
        completionHandler: (void (^)(EzsignfolderDisposeV1Response* output, NSError* error)) handler;

Dispose the 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* pkiEzsignfolderID = @56; // 
NSObject* body = NULL; // 

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

// Dispose the Ezsignfolder
[apiInstance ezsignfolderDisposeV1WithPkiEzsignfolderID:pkiEzsignfolderID
              body:body
          completionHandler: ^(EzsignfolderDisposeV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderDisposeV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
body	NSObject*

Return type

EzsignfolderDisposeV1Response*

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]

ezsignfolderEditObjectV1

-(NSURLSessionTask*) ezsignfolderEditObjectV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    ezsignfolderEditObjectV1Request: (EzsignfolderEditObjectV1Request*) ezsignfolderEditObjectV1Request
        completionHandler: (void (^)(EzsignfolderEditObjectV1Response* output, NSError* error)) handler;

Edit an existing 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* pkiEzsignfolderID = @56; // 
EzsignfolderEditObjectV1Request* ezsignfolderEditObjectV1Request = [[EzsignfolderEditObjectV1Request alloc] init]; // 

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

// Edit an existing Ezsignfolder
[apiInstance ezsignfolderEditObjectV1WithPkiEzsignfolderID:pkiEzsignfolderID
              ezsignfolderEditObjectV1Request:ezsignfolderEditObjectV1Request
          completionHandler: ^(EzsignfolderEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderEditObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
ezsignfolderEditObjectV1Request	EzsignfolderEditObjectV1Request*

Return type

EzsignfolderEditObjectV1Response*

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]

ezsignfolderEndPrematurelyV1

-(NSURLSessionTask*) ezsignfolderEndPrematurelyV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    body: (NSObject*) body
        completionHandler: (void (^)(EzsignfolderEndPrematurelyV1Response* output, NSError* error)) handler;

End prematurely

End prematurely all Ezsigndocument of Ezsignfolder when some signatures are still required

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* pkiEzsignfolderID = @56; // 
NSObject* body = NULL; // 

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

// End prematurely
[apiInstance ezsignfolderEndPrematurelyV1WithPkiEzsignfolderID:pkiEzsignfolderID
              body:body
          completionHandler: ^(EzsignfolderEndPrematurelyV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderEndPrematurelyV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
body	NSObject*

Return type

EzsignfolderEndPrematurelyV1Response*

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]

ezsignfolderGetActionableElementsV1

-(NSURLSessionTask*) ezsignfolderGetActionableElementsV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetActionableElementsV1Response* output, NSError* error)) handler;

Retrieve actionable elements for the Ezsignfolder

Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process

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

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

// Retrieve actionable elements for the Ezsignfolder
[apiInstance ezsignfolderGetActionableElementsV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetActionableElementsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetActionableElementsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetActionableElementsV1Response*

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]

ezsignfolderGetAttachmentCountV1

-(NSURLSessionTask*) ezsignfolderGetAttachmentCountV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetAttachmentCountV1Response* output, NSError* error)) handler;

Retrieve Attachment 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* pkiEzsignfolderID = @56; // 

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

// Retrieve Attachment count
[apiInstance ezsignfolderGetAttachmentCountV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetAttachmentCountV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetAttachmentCountV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetAttachmentCountV1Response*

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]

ezsignfolderGetAttachmentsV1

-(NSURLSessionTask*) ezsignfolderGetAttachmentsV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetAttachmentsV1Response* output, NSError* error)) handler;

Retrieve Ezsignfolder'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* pkiEzsignfolderID = @56; // 

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

// Retrieve Ezsignfolder's Attachments
[apiInstance ezsignfolderGetAttachmentsV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetAttachmentsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetAttachmentsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetAttachmentsV1Response*

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]

ezsignfolderGetCommunicationCountV1

-(NSURLSessionTask*) ezsignfolderGetCommunicationCountV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetCommunicationCountV1Response* 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* pkiEzsignfolderID = @56; // 

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

// Retrieve Communication count
[apiInstance ezsignfolderGetCommunicationCountV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetCommunicationCountV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetCommunicationCountV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetCommunicationCountV1Response*

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]

ezsignfolderGetCommunicationListV1

-(NSURLSessionTask*) ezsignfolderGetCommunicationListV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetCommunicationListV1Response* 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* pkiEzsignfolderID = @56; // 

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

// Retrieve Communication list
[apiInstance ezsignfolderGetCommunicationListV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetCommunicationListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetCommunicationListV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetCommunicationListV1Response*

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]

ezsignfolderGetCommunicationrecipientsV1

-(NSURLSessionTask*) ezsignfolderGetCommunicationrecipientsV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetCommunicationrecipientsV1Response* output, NSError* error)) handler;

Retrieve Ezsignfolder'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* pkiEzsignfolderID = @56; // 

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

// Retrieve Ezsignfolder's Communicationrecipient
[apiInstance ezsignfolderGetCommunicationrecipientsV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetCommunicationrecipientsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetCommunicationrecipientsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetCommunicationrecipientsV1Response*

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]

ezsignfolderGetCommunicationsendersV1

-(NSURLSessionTask*) ezsignfolderGetCommunicationsendersV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetCommunicationsendersV1Response* output, NSError* error)) handler;

Retrieve Ezsignfolder'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* pkiEzsignfolderID = @56; // 

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

// Retrieve Ezsignfolder's Communicationsender
[apiInstance ezsignfolderGetCommunicationsendersV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetCommunicationsendersV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetCommunicationsendersV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetCommunicationsendersV1Response*

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]

ezsignfolderGetEzsigndocumentsV1

-(NSURLSessionTask*) ezsignfolderGetEzsigndocumentsV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetEzsigndocumentsV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsignfolder's Ezsigndocuments

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

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

// Retrieve an existing Ezsignfolder's Ezsigndocuments
[apiInstance ezsignfolderGetEzsigndocumentsV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetEzsigndocumentsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetEzsigndocumentsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetEzsigndocumentsV1Response*

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]

ezsignfolderGetEzsignfoldersignerassociationsV1

-(NSURLSessionTask*) ezsignfolderGetEzsignfoldersignerassociationsV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetEzsignfoldersignerassociationsV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations

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

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

// Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations
[apiInstance ezsignfolderGetEzsignfoldersignerassociationsV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetEzsignfoldersignerassociationsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetEzsignfoldersignerassociationsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetEzsignfoldersignerassociationsV1Response*

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]

ezsignfolderGetEzsignsignaturesAutomaticV1

-(NSURLSessionTask*) ezsignfolderGetEzsignsignaturesAutomaticV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetEzsignsignaturesAutomaticV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsignfolder's automatic Ezsignsignatures

Return the Ezsignsignatures that can be signed by the current user at the current step in the process

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

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

// Retrieve an existing Ezsignfolder's automatic Ezsignsignatures
[apiInstance ezsignfolderGetEzsignsignaturesAutomaticV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetEzsignsignaturesAutomaticV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetEzsignsignaturesAutomaticV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetEzsignsignaturesAutomaticV1Response*

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]

ezsignfolderGetFormsDataV1

-(NSURLSessionTask*) ezsignfolderGetFormsDataV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetFormsDataV1Response* output, NSError* error)) handler;

Retrieve an existing Ezsignfolder's forms data

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

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

// Retrieve an existing Ezsignfolder's forms data
[apiInstance ezsignfolderGetFormsDataV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetFormsDataV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetFormsDataV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetFormsDataV1Response*

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/zip

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

ezsignfolderGetListV1

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

Retrieve Ezsignfolder list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsignfolderStep | Unsent
Sent
PartiallySigned
Expired
Completed
Archived
Disposed| | eEzsignfoldertypePrivacylevel | User
Usergroup | Advanced filters that can be used in query parameter sFilter: | Variable | |---| | fkiUserID | | sContactFirstname | | sContactLastname | | sEzsigndocumentName |

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)

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

// Retrieve Ezsignfolder list
[apiInstance ezsignfolderGetListV1WithEOrderBy:eOrderBy
              iRowMax:iRowMax
              iRowOffset:iRowOffset
              acceptLanguage:acceptLanguage
              sFilter:sFilter
          completionHandler: ^(EzsignfolderGetListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetListV1: %@", 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

EzsignfolderGetListV1Response*

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]

ezsignfolderGetObjectV1

-(NSURLSessionTask*) ezsignfolderGetObjectV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetObjectV1Response* output, NSError* error)) handler;

Retrieve an existing 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* pkiEzsignfolderID = @56; // 

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

// Retrieve an existing Ezsignfolder
[apiInstance ezsignfolderGetObjectV1WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetObjectV1Response*

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]

ezsignfolderGetObjectV2

-(NSURLSessionTask*) ezsignfolderGetObjectV2WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
        completionHandler: (void (^)(EzsignfolderGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing 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* pkiEzsignfolderID = @56; // 

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

// Retrieve an existing Ezsignfolder
[apiInstance ezsignfolderGetObjectV2WithPkiEzsignfolderID:pkiEzsignfolderID
          completionHandler: ^(EzsignfolderGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*

Return type

EzsignfolderGetObjectV2Response*

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]

ezsignfolderImportEzsignfoldersignerassociationsV1

-(NSURLSessionTask*) ezsignfolderImportEzsignfoldersignerassociationsV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    ezsignfolderImportEzsignfoldersignerassociationsV1Request: (EzsignfolderImportEzsignfoldersignerassociationsV1Request*) ezsignfolderImportEzsignfoldersignerassociationsV1Request
        completionHandler: (void (^)(EzsignfolderImportEzsignfoldersignerassociationsV1Response* output, NSError* error)) handler;

Import an existing Ezsignfoldersignerassociation into this 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* pkiEzsignfolderID = @56; // 
EzsignfolderImportEzsignfoldersignerassociationsV1Request* ezsignfolderImportEzsignfoldersignerassociationsV1Request = [[EzsignfolderImportEzsignfoldersignerassociationsV1Request alloc] init]; // 

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

// Import an existing Ezsignfoldersignerassociation into this Ezsignfolder
[apiInstance ezsignfolderImportEzsignfoldersignerassociationsV1WithPkiEzsignfolderID:pkiEzsignfolderID
              ezsignfolderImportEzsignfoldersignerassociationsV1Request:ezsignfolderImportEzsignfoldersignerassociationsV1Request
          completionHandler: ^(EzsignfolderImportEzsignfoldersignerassociationsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderImportEzsignfoldersignerassociationsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
ezsignfolderImportEzsignfoldersignerassociationsV1Request	EzsignfolderImportEzsignfoldersignerassociationsV1Request*

Return type

EzsignfolderImportEzsignfoldersignerassociationsV1Response*

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]

ezsignfolderImportEzsigntemplatepackageV1

-(NSURLSessionTask*) ezsignfolderImportEzsigntemplatepackageV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    ezsignfolderImportEzsigntemplatepackageV1Request: (EzsignfolderImportEzsigntemplatepackageV1Request*) ezsignfolderImportEzsigntemplatepackageV1Request
        completionHandler: (void (^)(EzsignfolderImportEzsigntemplatepackageV1Response* output, NSError* error)) handler;

Import an Ezsigntemplatepackage in the Ezsignfolder.

This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments. This allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step.

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* pkiEzsignfolderID = @56; // 
EzsignfolderImportEzsigntemplatepackageV1Request* ezsignfolderImportEzsigntemplatepackageV1Request = [[EzsignfolderImportEzsigntemplatepackageV1Request alloc] init]; // 

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

// Import an Ezsigntemplatepackage in the Ezsignfolder.
[apiInstance ezsignfolderImportEzsigntemplatepackageV1WithPkiEzsignfolderID:pkiEzsignfolderID
              ezsignfolderImportEzsigntemplatepackageV1Request:ezsignfolderImportEzsigntemplatepackageV1Request
          completionHandler: ^(EzsignfolderImportEzsigntemplatepackageV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderImportEzsigntemplatepackageV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
ezsignfolderImportEzsigntemplatepackageV1Request	EzsignfolderImportEzsigntemplatepackageV1Request*

Return type

EzsignfolderImportEzsigntemplatepackageV1Response*

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]

ezsignfolderReorderV1

-(NSURLSessionTask*) ezsignfolderReorderV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    ezsignfolderReorderV1Request: (EzsignfolderReorderV1Request*) ezsignfolderReorderV1Request
        completionHandler: (void (^)(EzsignfolderReorderV1Response* output, NSError* error)) handler;

Reorder Ezsigndocuments in the 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* pkiEzsignfolderID = @56; // 
EzsignfolderReorderV1Request* ezsignfolderReorderV1Request = [[EzsignfolderReorderV1Request alloc] init]; // 

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

// Reorder Ezsigndocuments in the Ezsignfolder
[apiInstance ezsignfolderReorderV1WithPkiEzsignfolderID:pkiEzsignfolderID
              ezsignfolderReorderV1Request:ezsignfolderReorderV1Request
          completionHandler: ^(EzsignfolderReorderV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderReorderV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
ezsignfolderReorderV1Request	EzsignfolderReorderV1Request*

Return type

EzsignfolderReorderV1Response*

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]

ezsignfolderSendV1

-(NSURLSessionTask*) ezsignfolderSendV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    ezsignfolderSendV1Request: (EzsignfolderSendV1Request*) ezsignfolderSendV1Request
        completionHandler: (void (^)(EzsignfolderSendV1Response* output, NSError* error)) handler;

Send the Ezsignfolder to the signatories for signature

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* pkiEzsignfolderID = @56; // 
EzsignfolderSendV1Request* ezsignfolderSendV1Request = [[EzsignfolderSendV1Request alloc] init]; // 

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

// Send the Ezsignfolder to the signatories for signature
[apiInstance ezsignfolderSendV1WithPkiEzsignfolderID:pkiEzsignfolderID
              ezsignfolderSendV1Request:ezsignfolderSendV1Request
          completionHandler: ^(EzsignfolderSendV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderSendV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
ezsignfolderSendV1Request	EzsignfolderSendV1Request*

Return type

EzsignfolderSendV1Response*

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]

ezsignfolderSendV3

-(NSURLSessionTask*) ezsignfolderSendV3WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    ezsignfolderSendV3Request: (EzsignfolderSendV3Request*) ezsignfolderSendV3Request
        completionHandler: (void (^)(EzsignfolderSendV3Response* output, NSError* error)) handler;

Send the Ezsignfolder to the signatories for signature

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* pkiEzsignfolderID = @56; // 
EzsignfolderSendV3Request* ezsignfolderSendV3Request = [[EzsignfolderSendV3Request alloc] init]; // 

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

// Send the Ezsignfolder to the signatories for signature
[apiInstance ezsignfolderSendV3WithPkiEzsignfolderID:pkiEzsignfolderID
              ezsignfolderSendV3Request:ezsignfolderSendV3Request
          completionHandler: ^(EzsignfolderSendV3Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderSendV3: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
ezsignfolderSendV3Request	EzsignfolderSendV3Request*

Return type

EzsignfolderSendV3Response*

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]

ezsignfolderUnsendV1

-(NSURLSessionTask*) ezsignfolderUnsendV1WithPkiEzsignfolderID: (NSNumber*) pkiEzsignfolderID
    body: (NSObject*) body
        completionHandler: (void (^)(EzsignfolderUnsendV1Response* output, NSError* error)) handler;

Unsend the Ezsignfolder

Once an Ezsignfolder has been sent to signatories, it cannot be modified. Using this endpoint, you can unsend the Ezsignfolder and make it modifiable again. Signatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign. ⚠️ Warning: Any signature previously made by signatories on "Non-completed" Ezsigndocuments will be lost.

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* pkiEzsignfolderID = @56; // 
NSObject* body = NULL; // 

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

// Unsend the Ezsignfolder
[apiInstance ezsignfolderUnsendV1WithPkiEzsignfolderID:pkiEzsignfolderID
              body:body
          completionHandler: ^(EzsignfolderUnsendV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectEzsignfolderApi->ezsignfolderUnsendV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiEzsignfolderID	NSNumber*
body	NSObject*

Return type

EzsignfolderUnsendV1Response*

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]

Files

ObjectEzsignfolderApi.md

Latest commit

History

ObjectEzsignfolderApi.md

File metadata and controls

ObjectEzsignfolderApi

ezsignfolderArchiveV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderBatchDownloadV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderCreateObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderCreateObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderDeleteObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderDisposeEzsignfoldersV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderDisposeV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderEditObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderEndPrematurelyV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderGetActionableElementsV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderGetAttachmentCountV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderGetAttachmentsV1

Example

Parameters

Return type

Authorization

HTTP request headers

ezsignfolderGetCommunicationCountV1