Skip to content

Latest commit

 

History

History
317 lines (219 loc) · 11.9 KB

ObjectEzsignfoldertypeApi.md

File metadata and controls

317 lines (219 loc) · 11.9 KB

openapi.api.ObjectEzsignfoldertypeApi

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
ezsignfoldertypeCreateObjectV3 POST /3/object/ezsignfoldertype Create a new Ezsignfoldertype
ezsignfoldertypeEditObjectV3 PUT /3/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Edit an existing Ezsignfoldertype
ezsignfoldertypeGetAutocompleteV2 GET /2/object/ezsignfoldertype/getAutocomplete/{sSelector} Retrieve Ezsignfoldertypes and IDs
ezsignfoldertypeGetListV1 GET /1/object/ezsignfoldertype/getList Retrieve Ezsignfoldertype list
ezsignfoldertypeGetObjectV2 GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype
ezsignfoldertypeGetObjectV4 GET /4/object/ezsignfoldertype/{pkiEzsignfoldertypeID} Retrieve an existing Ezsignfoldertype

ezsignfoldertypeCreateObjectV3

EzsignfoldertypeCreateObjectV3Response ezsignfoldertypeCreateObjectV3(ezsignfoldertypeCreateObjectV3Request)

Create a new Ezsignfoldertype

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

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 = ObjectEzsignfoldertypeApi();
final ezsignfoldertypeCreateObjectV3Request = EzsignfoldertypeCreateObjectV3Request(); // EzsignfoldertypeCreateObjectV3Request | 

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

Parameters

Name Type Description Notes
ezsignfoldertypeCreateObjectV3Request EzsignfoldertypeCreateObjectV3Request

Return type

EzsignfoldertypeCreateObjectV3Response

Authorization

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]

ezsignfoldertypeEditObjectV3

EzsignfoldertypeEditObjectV3Response ezsignfoldertypeEditObjectV3(pkiEzsignfoldertypeID, ezsignfoldertypeEditObjectV3Request)

Edit an existing Ezsignfoldertype

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 = ObjectEzsignfoldertypeApi();
final pkiEzsignfoldertypeID = 56; // int | 
final ezsignfoldertypeEditObjectV3Request = EzsignfoldertypeEditObjectV3Request(); // EzsignfoldertypeEditObjectV3Request | 

try {
    final result = api_instance.ezsignfoldertypeEditObjectV3(pkiEzsignfoldertypeID, ezsignfoldertypeEditObjectV3Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertypeEditObjectV3: $e\n');
}

Parameters

Name Type Description Notes
pkiEzsignfoldertypeID int
ezsignfoldertypeEditObjectV3Request EzsignfoldertypeEditObjectV3Request

Return type

EzsignfoldertypeEditObjectV3Response

Authorization

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]

ezsignfoldertypeGetAutocompleteV2

EzsignfoldertypeGetAutocompleteV2Response ezsignfoldertypeGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Ezsignfoldertypes and IDs

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

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 = ObjectEzsignfoldertypeApi();
final sSelector = sSelector_example; // String | The type of Ezsignfoldertypes to return
final eFilterActive = eFilterActive_example; // String | Specify which results we want to display.
final sQuery = sQuery_example; // String | Allow to filter the returned results
final acceptLanguage = ; // HeaderAcceptLanguage | 

try {
    final result = api_instance.ezsignfoldertypeGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
    print(result);
} catch (e) {
    print('Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertypeGetAutocompleteV2: $e\n');
}

Parameters

Name Type Description Notes
sSelector String The type of Ezsignfoldertypes to return
eFilterActive String Specify which results we want to display. [optional] [default to 'Active']
sQuery String Allow to filter the returned results [optional]
acceptLanguage HeaderAcceptLanguage [optional]

Return type

EzsignfoldertypeGetAutocompleteV2Response

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]

ezsignfoldertypeGetListV1

EzsignfoldertypeGetListV1Response ezsignfoldertypeGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Ezsignfoldertype list

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

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 = ObjectEzsignfoldertypeApi();
final eOrderBy = eOrderBy_example; // String | Specify how you want the results to be sorted
final iRowMax = 56; // int | 
final iRowOffset = 56; // int | 
final acceptLanguage = ; // HeaderAcceptLanguage | 
final sFilter = sFilter_example; // String | 

try {
    final result = api_instance.ezsignfoldertypeGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    print(result);
} catch (e) {
    print('Exception when calling ObjectEzsignfoldertypeApi->ezsignfoldertypeGetListV1: $e\n');
}

Parameters

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

Return type

EzsignfoldertypeGetListV1Response

Authorization

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]

ezsignfoldertypeGetObjectV2

EzsignfoldertypeGetObjectV2Response ezsignfoldertypeGetObjectV2(pkiEzsignfoldertypeID)

Retrieve an existing Ezsignfoldertype

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 = ObjectEzsignfoldertypeApi();
final pkiEzsignfoldertypeID = 56; // int | 

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

Parameters

Name Type Description Notes
pkiEzsignfoldertypeID int

Return type

EzsignfoldertypeGetObjectV2Response

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]

ezsignfoldertypeGetObjectV4

EzsignfoldertypeGetObjectV4Response ezsignfoldertypeGetObjectV4(pkiEzsignfoldertypeID)

Retrieve an existing Ezsignfoldertype

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 = ObjectEzsignfoldertypeApi();
final pkiEzsignfoldertypeID = 56; // int | 

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

Parameters

Name Type Description Notes
pkiEzsignfoldertypeID int

Return type

EzsignfoldertypeGetObjectV4Response

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]