Skip to content

Latest commit

 

History

History
241 lines (167 loc) · 11.5 KB

ObjectEzsigntemplatepackageAPI.md

File metadata and controls

241 lines (167 loc) · 11.5 KB
Raw

ObjectEzsigntemplatepackageAPI

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

Method HTTP request Description
ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageCreateObjectV1 POST /1/object/ezsigntemplatepackage Create a new Ezsigntemplatepackage
ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageDeleteObjectV1 DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Delete an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageEditEzsigntemplatepackagesignersV1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners Edit multiple Ezsigntemplatepackagesigners
ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageEditObjectV1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Edit an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageGetAutocompleteV2 GET /2/object/ezsigntemplatepackage/getAutocomplete/{sSelector} Retrieve Ezsigntemplatepackages and IDs
ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageGetListV1 GET /1/object/ezsigntemplatepackage/getList Retrieve Ezsigntemplatepackage list
ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageGetObjectV2 GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Retrieve an existing Ezsigntemplatepackage

ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageCreateObjectV1

// Create a new Ezsigntemplatepackage
//
// The endpoint allows to create one or many elements at once.
//
ezsigntemplatepackage_create_object_v1_response_t* ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageCreateObjectV1(apiClient_t *apiClient, ezsigntemplatepackage_create_object_v1_request_t *ezsigntemplatepackage_create_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
ezsigntemplatepackage_create_object_v1_request ezsigntemplatepackage_create_object_v1_request_t *

Return type

ezsigntemplatepackage_create_object_v1_response_t *

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]

ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageDeleteObjectV1

// Delete an existing Ezsigntemplatepackage
//
// 
//
ezsigntemplatepackage_delete_object_v1_response_t* ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageDeleteObjectV1(apiClient_t *apiClient, int *pkiEzsigntemplatepackageID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsigntemplatepackageID int *

Return type

ezsigntemplatepackage_delete_object_v1_response_t *

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]

ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageEditEzsigntemplatepackagesignersV1

// Edit multiple Ezsigntemplatepackagesigners
//
// Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners at the same time.
//
ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_t* ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageEditEzsigntemplatepackagesignersV1(apiClient_t *apiClient, int *pkiEzsigntemplatepackageID, ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request_t *ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsigntemplatepackageID int *
ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_request_t *

Return type

ezsigntemplatepackage_edit_ezsigntemplatepackagesigners_v1_response_t *

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]

ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageEditObjectV1

// Edit an existing Ezsigntemplatepackage
//
// 
//
ezsigntemplatepackage_edit_object_v1_response_t* ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageEditObjectV1(apiClient_t *apiClient, int *pkiEzsigntemplatepackageID, ezsigntemplatepackage_edit_object_v1_request_t *ezsigntemplatepackage_edit_object_v1_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsigntemplatepackageID int *
ezsigntemplatepackage_edit_object_v1_request ezsigntemplatepackage_edit_object_v1_request_t *

Return type

ezsigntemplatepackage_edit_object_v1_response_t *

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]

ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageGetAutocompleteV2

// Retrieve Ezsigntemplatepackages and IDs
//
// Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete control.
//
ezsigntemplatepackage_get_autocomplete_v2_response_t* ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageGetAutocompleteV2(apiClient_t *apiClient, ezmax_api_definition__full_ezsigntemplatepackageGetAutocompleteV2_sSelector_e sSelector, ezmax_api_definition__full_ezsigntemplatepackageGetAutocompleteV2_eFilterActive_e eFilterActive, char *sQuery, header_accept_language_e Accept_Language);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
sSelector ezmax_api_definition__full_ezsigntemplatepackageGetAutocompleteV2_sSelector_e The type of Ezsigntemplatepackages to return
eFilterActive ezmax_api_definition__full_ezsigntemplatepackageGetAutocompleteV2_eFilterActive_e Specify which results we want to display. [optional] [default to 'Active']
sQuery char * Allow to filter the returned results [optional]
Accept_Language header_accept_language_e [optional]

Return type

ezsigntemplatepackage_get_autocomplete_v2_response_t *

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]

ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageGetListV1

// Retrieve Ezsigntemplatepackage list
//
// Enum values that can be filtered in query parameter *sFilter*:  | Variable | Valid values | |---|---| | eEzsigntemplatepackageType | Company<br>Team<br>User<br>Usergroup |
//
ezsigntemplatepackage_get_list_v1_response_t* ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageGetListV1(apiClient_t *apiClient, ezmax_api_definition__full_ezsigntemplatepackageGetListV1_eOrderBy_e eOrderBy, int *iRowMax, int *iRowOffset, header_accept_language_e Accept_Language, char *sFilter);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
eOrderBy ezmax_api_definition__full_ezsigntemplatepackageGetListV1_eOrderBy_e Specify how you want the results to be sorted [optional]
iRowMax int * [optional]
iRowOffset int * [optional] [default to 0]
Accept_Language header_accept_language_e [optional]
sFilter char * [optional]

Return type

ezsigntemplatepackage_get_list_v1_response_t *

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]

ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageGetObjectV2

// Retrieve an existing Ezsigntemplatepackage
//
// 
//
ezsigntemplatepackage_get_object_v2_response_t* ObjectEzsigntemplatepackageAPI_ezsigntemplatepackageGetObjectV2(apiClient_t *apiClient, int *pkiEzsigntemplatepackageID);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
pkiEzsigntemplatepackageID int *

Return type

ezsigntemplatepackage_get_object_v2_response_t *

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]