Skip to content

Latest commit

 

History

History
205 lines (137 loc) · 7.87 KB

ObjectEzsignbulksendtransmissionApi.md

File metadata and controls

205 lines (137 loc) · 7.87 KB
Raw

openapi.api.ObjectEzsignbulksendtransmissionApi

Load the API package

import 'package:openapi/api.dart';

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

Method HTTP request Description
ezsignbulksendtransmissionGetCsvErrorsV1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getCsvErrors Retrieve an existing Ezsignbulksendtransmission's Csv containing errors
ezsignbulksendtransmissionGetEzsignsignaturesAutomaticV1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures
ezsignbulksendtransmissionGetFormsDataV1 GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData Retrieve an existing Ezsignbulksendtransmission's forms data
ezsignbulksendtransmissionGetObjectV2 GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} Retrieve an existing Ezsignbulksendtransmission

ezsignbulksendtransmissionGetCsvErrorsV1

String ezsignbulksendtransmissionGetCsvErrorsV1(pkiEzsignbulksendtransmissionID)

Retrieve an existing Ezsignbulksendtransmission's Csv containing errors

Example

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

final api_instance = ObjectEzsignbulksendtransmissionApi();
final pkiEzsignbulksendtransmissionID = 56; // int | 

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

Parameters

Name Type Description Notes
pkiEzsignbulksendtransmissionID int

Return type

String

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/csv, application/json

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

ezsignbulksendtransmissionGetEzsignsignaturesAutomaticV1

EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response ezsignbulksendtransmissionGetEzsignsignaturesAutomaticV1(pkiEzsignbulksendtransmissionID)

Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures

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

Example

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

final api_instance = ObjectEzsignbulksendtransmissionApi();
final pkiEzsignbulksendtransmissionID = 56; // int | 

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

Parameters

Name Type Description Notes
pkiEzsignbulksendtransmissionID int

Return type

EzsignbulksendtransmissionGetEzsignsignaturesAutomaticV1Response

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]

ezsignbulksendtransmissionGetFormsDataV1

EzsignbulksendtransmissionGetFormsDataV1Response ezsignbulksendtransmissionGetFormsDataV1(pkiEzsignbulksendtransmissionID)

Retrieve an existing Ezsignbulksendtransmission's forms data

Example

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

final api_instance = ObjectEzsignbulksendtransmissionApi();
final pkiEzsignbulksendtransmissionID = 56; // int | 

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

Parameters

Name Type Description Notes
pkiEzsignbulksendtransmissionID int

Return type

EzsignbulksendtransmissionGetFormsDataV1Response

Authorization

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]

ezsignbulksendtransmissionGetObjectV2

EzsignbulksendtransmissionGetObjectV2Response ezsignbulksendtransmissionGetObjectV2(pkiEzsignbulksendtransmissionID)

Retrieve an existing Ezsignbulksendtransmission

Example

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

final api_instance = ObjectEzsignbulksendtransmissionApi();
final pkiEzsignbulksendtransmissionID = 56; // int | 

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

Parameters

Name Type Description Notes
pkiEzsignbulksendtransmissionID int

Return type

EzsignbulksendtransmissionGetObjectV2Response

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]