eZmax API

https://eZmaxinc.github.io/eZmax-API/docs/
Admin
The eZmax API provides comprehensive documentation and definitions for the eZmax and eZsign...
Tokens:174,373
Snippets:569
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Copy Ezsigntemplate Response Example

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Example response structure for a successful copy operation, including payload and debug information.

```json
{
  "mPayload": {
    "a_pkiEzsigntemplateID": [
      36
]
},
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
},
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
},
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
}
]
}
}
```

--------------------------------

### Ezsigntemplatepackage Autocomplete Response

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Example JSON response structure for the getAutocomplete endpoint.

```json
{
  "mPayload": {
    "a_objEzsigntemplatepackage": [
      {
        "eEzsignfoldertypePrivacylevel": "User",
        "sEzsigntemplatepackageDescription": "Package for new clients",
        "pkiEzsigntemplatepackageID": 99,
        "bEzsigntemplatepackageIsactive": true,
        "bDisabled": true
      }
    ]
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
    ],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      },
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      }
    ]
  }
}
```

--------------------------------

### GET /1/object/ezsignfolder/getList

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves a list of Ezsignfolders with support for filtering, sorting, and pagination.

```APIDOC
## GET /1/object/ezsignfolder/getList

### Description
Retrieve a list of Ezsignfolders. This endpoint supports filtering by various fields, sorting, and pagination.

### Method
GET

### Endpoint
/1/object/ezsignfolder/getList

### Parameters
#### Query Parameters
- **eOrderBy** (string) - Optional - Specify how you want the results to be sorted. Enum: "pkiEzsignfolderID_ASC", "pkiEzsignfolderID_DESC", "sEzsignfolderDescription_ASC", "sEzsignfolderDescription_DESC", "dtCreatedDate_ASC", etc.
- **iRowMax** (integer) - Optional - The maximum number of results to be returned (1-10000).
- **iRowOffset** (integer) - Optional - The starting element from where to start retrieving the results (Default: 0).
- **sFilter** (string) - Optional - The filter to apply to the request to limit results.

#### Header Parameters
- **Accept-Language** (string) - Optional - The language of the returned content. Enum: "*", "en", "fr".

### Response
#### Success Response (200)
- Successful response

#### Error Response (406)
- The URL is valid, but the Accept header is not defined or invalid.
```

--------------------------------

### Ezsignfolder Creation Response Sample

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Example of a successful 201 response after creating an Ezsignfolder.

```json
{
  "mPayload": {
    "a_pkiEzsignfolderID": [
      33
    ]
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
    ],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      },
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      }
    ]
  }
}
```

--------------------------------

### HTTP Request Headers for GET Request

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/remaxqc/ezmax.v1.3.html

Required headers for authenticating a GET request to the activesession endpoint.

```http
Authorization: ThisIsMyAuthorizationKey
Ezmax-Date: 2000-12-31T23:59:59Z
Ezmax-Fingerprint: v1=8f6f3ed75edb6e2cbe777b4fda5cab1a6adaebadc758780eb82c3d49934f354a
Ezmax-Signature: v1=3a95fde64d27527745bcb0dd91be8caf7917c6778197e22d1d56c87245f979f5
```

--------------------------------

### Apply Ezsigntemplate Response Sample

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Example of a successful 200 response containing debug information and warnings.

```json
{
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
},
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
},
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
}
]
},
  "a_objWarning": [
    {
      "sWarningMessage": "string",
      "eWarningCode": "string"
}
]

}
```

--------------------------------

### Create Branding Response Sample

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Successful response structure returned after creating a branding object.

```json
{
  "mPayload": {
    "a_pkiBrandingID": [
      78
    ]
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
    ],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      },
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      }
    ]
  }
}
```

--------------------------------

### GET /2/object/activesession/getCurrent

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieve the details about the current activesession.

```APIDOC
## GET /2/object/activesession/getCurrent

### Description
Retrieve the details about the current activesession.

### Method
GET

### Endpoint
/2/object/activesession/getCurrent

### Responses
#### Success Response (200)
- **mPayload** (object) - The payload containing the active session details.
- **objDebugPayload** (object) - Debug information regarding the API version and response date.
- **objDebug** (object) - Performance metrics including memory usage and SQL query details.

#### Error Responses
- **350** - The user must authenticate before he can continue with this request
- **351** - The user is configured with 2FA and needs to validate its phone number
- **352** - The user is configured with 2FA and needs to answer a Secretquestion
- **353** - The user must accept clauses
- **354** - The user's computer must be validated
- **355** - The user must change its password
- **356** - The user is not running the latest version of the native application

### Response Example
{
  "mPayload": {
    "objActivesession": {
      "eActivesessionUsertype": "Normal",
      "pksCustomerCode": "demo"
    }
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2
  }
}
```

--------------------------------

### GET /4/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves an existing Ezsigntemplatesignature by its unique ID.

```APIDOC
## GET /4/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}

### Description
Retrieve an existing Ezsigntemplatesignature.

### Method
GET

### Endpoint
/4/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}

### Parameters
#### Path Parameters
- **pkiEzsigntemplatesignatureID** (integer) - Required - The unique ID of the Ezsigntemplatesignature (>= 0)

### Response
#### Success Response (200)
- Successful response

#### Error Response (404)
- The request failed. The element on which you were trying to work does not exist.
```

--------------------------------

### Create Ezsigntemplate Response Sample

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Successful response structure for the Ezsigntemplate creation endpoint.

```json
{
  "mPayload": {
    "a_pkiEzsigntemplateID": [
      36
    ]
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
    ],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      },
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      }
    ]
  }
}
```

--------------------------------

### GET /2/object/ezsigntemplateglobalannotation/{pkiEzsigntemplateglobalannotationID}

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves the details of an existing Ezsigntemplateglobalannotation by its ID.

```APIDOC
## GET /2/object/ezsigntemplateglobalannotation/{pkiEzsigntemplateglobalannotationID}

### Description
Retrieve an existing Ezsigntemplateglobalannotation by providing its unique ID.

### Method
GET

### Endpoint
/2/object/ezsigntemplateglobalannotation/{pkiEzsigntemplateglobalannotationID}

### Parameters
#### Path Parameters
- **pkiEzsigntemplateglobalannotationID** (integer) - Required - The unique ID of the Ezsigntemplateglobalannotation (Range: 0 to 16777215).

### Response
#### Success Response (200)
- **mPayload** (object) - The payload containing the Ezsigntemplateglobalannotation object.
- **objDebugPayload** (object) - Debug information regarding the request.
- **objDebug** (object) - Detailed debug information including memory usage and SQL queries.

#### Response Example
{
  "mPayload": {
    "objEzsigntemplateglobalannotation": {
      "pkiEzsigntemplateglobalannotationID": 200,
      "fkiTextstylestaticID": 216,
      "objTextstylestatic": {
        "fkiFontID": 1,
        "bTextstylestaticBold": true,
        "bTextstylestaticUnderline": true,
        "bTextstylestaticItalic": true,
        "bTextstylestaticStrikethrough": true,
        "iTextstylestaticFontcolor": 3752795,
        "iTextstylestaticSize": 12
      },
      "eEzsigntemplateglobalannotationHorizontalalignment": "Center",
      "eEzsigntemplateglobalannotationVerticalalignment": "Bottom",
      "eEzsigntemplateglobalannotationType": "Dropdown",
      "iEzsigntemplateglobalannotationX": 59074,
      "iEzsigntemplateglobalannotationY": 27324,
      "iEzsigntemplateglobalannotationWidth": 26049,
      "iEzsigntemplateglobalannotationHeight": 31702,
      "iEzsigntemplateglobaldocumentpagePagenumber": 1,
      "sEzsigntemplateglobalannotationDescription": "Name",
      "sEzsigntemplateglobalannotationDefaulttext": "John Doe",
      "sEzsigntemplateglobalannotationDropdownvalues": "{\"Accepts\",\"Refuses\"}"
    }
  }
}
```

--------------------------------

### Create Ezsigntemplatesigner Response Sample

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Successful response structure returned after creating an Ezsigntemplatesigner.

```json
{
  "mPayload": {
    "a_pkiEzsigntemplatesignerID": [
      9
    ],
    "bEzsigntemplatepackageNeedvalidation": true,
    "bEzsignbulksendNeedvalidation": true
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
    ],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      },
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      }
    ]
  }
}
```

--------------------------------

### POST /3/object/ezsignfolder

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Creates one or many Ezsignfolder elements at once.

```APIDOC
## POST /3/object/ezsignfolder

### Description
This endpoint allows the creation of one or many Ezsignfolder elements.

### Method
POST

### Endpoint
/3/object/ezsignfolder

### Request Body
- **a_objEzsignfolder** (Array of ezsignfolder-RequestCompoundV3) - Required - Array of objects to create.

### Request Example
{
  "a_objEzsignfolder": [
    {
      "pkiEzsignfolderID": 33,
      "fkiEzsignfoldertypeID": 5,
      "fkiTimezoneID": 247,
      "fkiEzsigntsarequirementID": 1,
      "eEzsignfolderDocumentdependency": "All",
      "sEzsignfolderDescription": "Test eZsign Folder",
      "tEzsignfolderNote": "This is a note",
      "tEzsignfolderMessage": "Hi everyone,\n\nThis is the document I need you to review.\n\nCould you sign it before Monday please.\n\nBest Regards.\n\nMary",
      "iEzsignfolderSendreminderfirstdays": 30,
      "iEzsignfolderSendreminderotherdays": 30,
      "sEzsignfolderExternalid": "{\"ID\": 1234, \"TAGS\": [\"tag1\", \"tag2\", \"tag3\"]}"
    }
  ]
}

### Response
#### Success Response (201)
- **mPayload** (Object) - Contains the list of created IDs.
- **objDebugPayload** (Object) - Debugging information.
- **objDebug** (Object) - Detailed system debug information.

#### Response Example
{
  "mPayload": {
    "a_pkiEzsignfolderID": [33]
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [117],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6
  }
}
```

--------------------------------

### GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves an existing Ezsigntemplateformfieldgroup by its unique ID.

```APIDOC
## GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}

### Description
Retrieves an existing Ezsigntemplateformfieldgroup object based on the provided unique identifier.

### Method
GET

### Endpoint
/2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}

### Parameters
#### Path Parameters
- **pkiEzsigntemplateformfieldgroupID** (integer) - Required - The unique ID of the Ezsigntemplateformfieldgroup (>= 0)

### Response
#### Success Response (200)
- Successful response

#### Error Response (404)
- The request failed. The element on which you were trying to work does not exist.
```

--------------------------------

### GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves the Ezsigntemplatesignatures for an existing Ezsigntemplatedocument.

```APIDOC
## GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures

### Description
Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures.

### Method
GET

### Endpoint
/2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures

### Parameters
#### Path Parameters
- **pkiEzsigntemplatedocumentID** (integer) - Required - The unique ID of the Ezsigntemplatedocument (>= 0)

### Response
#### Success Response (200)
- Successful response

#### Error Response (404)
- The request failed. The element on which you were trying to work does not exist.

#### Error Response (422)
- The request was syntactically valid but failed because of an interdependance condition.
```

--------------------------------

### GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpagerecognitions

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves the Ezsigntemplatedocumentpagerecognitions for an existing Ezsigntemplatedocument.

```APIDOC
## GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpagerecognitions

### Description
Retrieves the list of Ezsigntemplatedocumentpagerecognitions associated with the specified Ezsigntemplatedocument ID.

### Method
GET

### Endpoint
/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpagerecognitions

### Parameters
#### Path Parameters
- **pkiEzsigntemplatedocumentID** (integer) - Required - The unique ID of the Ezsigntemplatedocument (>= 0).

### Response
#### Success Response (200)
- **mPayload** (object) - The payload containing the list of Ezsigntemplatedocumentpagerecognition objects.

#### Response Example
{
  "mPayload": {
    "a_objEzsigntemplatedocumentpagerecognition": [
      {
        "pkiEzsigntemplatedocumentpagerecognitionID": 126,
        "fkiEzsigntemplatedocumentpageID": 85,
        "eEzsigntemplatedocumentpagerecognitionOperator": "eq",
        "eEzsigntemplatedocumentpagerecognitionSection": "FirstLine",
        "iEzsigntemplatedocumentpagerecognitionSimilarpercentage": 75,
        "iEzsigntemplatedocumentpagerecognitionX": 36325,
        "iEzsigntemplatedocumentpagerecognitionY": 407,
        "iEzsigntemplatedocumentpagerecognitionWidth": 29232,
        "iEzsigntemplatedocumentpagerecognitionHeight": 42651,
        "tEzsigntemplatedocumentpagerecognitionText": "Contract"
      }
    ]
  }
}
```

--------------------------------

### Ezsigntemplate List Response JSON

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Example of a successful 200 OK response body containing the Ezsigntemplate list and debug information.

```json
{
  * "mPayload": {
    * "a_objEzsigntemplate": [
      * {
        * "pkiEzsigntemplateID": 36,
        * "fkiEzsignfoldertypeID": 5,
        * "fkiLanguageID": 2,
        * "sEzsigntemplateDescription": "Standard Contract",
        * "iEzsigntemplatedocumentPagetotal": 5,
        * "iEzsigntemplateSignaturetotal": 8,
        * "iEzsigntemplateFormfieldtotal": 8,
        * "bEzsigntemplateIncomplete": false,
        * "sEzsignfoldertypeNameX": "Default",
        * "eEzsigntemplateType": "Ezsignfoldertype"
}
],
    * "iRowReturned": 100,
    * "iRowFiltered": 533
},
  * "objDebugPayload": {
    * "iVersionMin": 1,
    * "iVersionMax": 2,
    * "a_RequiredPermission": [
      * 117
],
    * "bVersionDeprecated": false,
    * "dtResponseDate": "2020-12-31 23:59:59",
    * "a_Filter": {
      * "a_AutoType": {
        * "property1": "string",
        * "property2": "string"
},
      * "a_AutoTypeHaving": {
        * "property1": "string",
        * "property2": "string"
},
      * "a_Enum": {
        * "property1": {
          * "property1": "string",
          * "property2": "string"
},
        * "property2": {
          * "property1": "string",
          * "property2": "string"
}
}
},
    * "a_OrderBy": {
      * "property1": "string",
      * "property2": "string"
},
    * "iRowMax": 100,
    * "iRowOffset": 0
},
  * "objDebug": {
    * "sMemoryUsage": "11,923MB",
    * "sRunTime": "0.6084s",
    * "iSQLSelects": 3,
    * "iSQLQueries": 6,
    * "a_objSQLQuery": [
      * {
        * "sQuery": "SELECT * FROM table",
        * "fDuration": 0.0001
},
      * {
        * "sQuery": "SELECT * FROM table",
        * "fDuration": 0.0001
}
]
}

}
```

--------------------------------

### GET /3/object/ezsigntemplate/{pkiEzsigntemplateID}

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves an existing Ezsigntemplate by its unique ID.

```APIDOC
## GET /3/object/ezsigntemplate/{pkiEzsigntemplateID}

### Description
Retrieves an existing Ezsigntemplate object based on the provided unique ID.

### Method
GET

### Endpoint
/3/object/ezsigntemplate/{pkiEzsigntemplateID}

### Parameters
#### Path Parameters
- **pkiEzsigntemplateID** (integer) - Required - The unique ID of the Ezsigntemplate (>= 0)

### Response
#### Success Response (200)
- Successful response

#### Error Response (404)
- The request failed. The element on which you were trying to work does not exist.
```

--------------------------------

### Create Ezsigntemplatedocument Response Sample

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

JSON structure returned upon a successful creation request.

```json
{
  "mPayload": {
    "a_pkiEzsigntemplatedocumentID": [
      133
    ]
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
    ],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      },
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      }
    ]
  }
}
```

--------------------------------

### GET /2/object/ezsigntemplatepackage/getAutocomplete/{sSelector}

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves a list of Ezsigntemplatepackage objects based on the provided selector.

```APIDOC
## GET /2/object/ezsigntemplatepackage/getAutocomplete/{sSelector}

### Description
Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete control.

### Method
GET

### Endpoint
/2/object/ezsigntemplatepackage/getAutocomplete/{sSelector}

### Parameters
#### Path Parameters
- **sSelector** (string) - Required - The type of Ezsigntemplatepackages to return. Enum: "All", "AllMultipleCopiesDisabled", "Ezsigntemplatepublic"

#### Query Parameters
- **eFilterActive** (string) - Optional - Specify which results we want to display. Default: "Active". Enum: "All", "Active", "Inactive"
- **sQuery** (string) - Optional - Allow to filter the returned results
- **fkiEzsignfoldertypeID** (integer) - Optional - The fkiEzsignfoldertypeID to use with the selector Ezsigntemplatepublic

#### Header Parameters
- **Accept-Language** (string) - Optional - The language of the returned content. Enum: "*", "en", "fr"

### Response
#### Success Response (200)
- **mPayload** (object) - Successful response containing the list of Ezsigntemplatepackage objects.
```

--------------------------------

### GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves the Ezsignsignatureattachments for a specific Ezsignsignature.

```APIDOC
## GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment

### Description
Retrieves a list of attachments associated with the specified Ezsignsignature ID.

### Method
GET

### Endpoint
/1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment

### Parameters
#### Path Parameters
- **pkiEzsignsignatureID** (integer) - Required - The unique ID of the Ezsignsignature (>= 0).

### Response
#### Success Response (200)
- **mPayload** (object) - The payload containing the list of attachments.
- **a_objEzsignsignatureattachment** (array) - List of Ezsignsignatureattachment objects.

#### Response Example
{
  "mPayload": {
    "a_objEzsignsignatureattachment": [
      {
        "pkiEzsignsignatureattachmentID": 177,
        "fkiEzsignsignatureID": 49,
        "binEzsignsignatureattachmentMD5": "098f6bcd4621d373cade4e832627b4f6",
        "sEzsignsignatureattachmentName": "document.pdf",
        "sDownloadUrl": "http://www.example.com/document.pdf"
      }
    ]
  }
}
```

--------------------------------

### Create User Response Sample

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

A successful 200 response sample for the createUser endpoint, including the payload and debug information.

```json
{
  "mPayload": {
    "pkiUserID": 70
},
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
},
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
},
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
}
]
}

}
```

--------------------------------

### GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves the Ezsignfoldersignerassociations for an existing Ezsignfolder.

```APIDOC
## GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations

### Description
Retrieves the list of Ezsignfoldersignerassociations associated with the specified Ezsignfolder ID.

### Method
GET

### Endpoint
/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations

### Parameters
#### Path Parameters
- **pkiEzsignfolderID** (integer) - Required - The unique ID of the Ezsignfolder (>= 0)

### Response
#### Success Response (200)
- **mPayload** (object) - The payload containing the list of Ezsignfoldersignerassociations.

#### Response Example
{
  "mPayload": {
    "a_objEzsignfoldersignerassociation": [
      {
        "pkiEzsignfoldersignerassociationID": 20,
        "fkiEzsignfolderID": 33,
        "bEzsignfoldersignerassociationDelayedsend": true,
        "bEzsignfoldersignerassociationReceivecopy": true,
        "tEzsignfoldersignerassociationMessage": "Hi John,\n\nThis is the document I need you to review.\n\nCould you sign it before Monday please.\n\nBest Regards.\n\nMary",
        "bEzsignfoldersignerassociationAllowsigninginperson": true
      }
    ]
  }
}
```

--------------------------------

### GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignannotations

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves the Ezsignannotations for a specified Ezsignfolder.

```APIDOC
## GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignannotations

### Description
Retrieves the Ezsignannotations associated with an existing Ezsignfolder.

### Method
GET

### Endpoint
/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignannotations

### Parameters
#### Path Parameters
- **pkiEzsignfolderID** (integer) - Required - The unique ID of the Ezsignfolder (>= 0).

### Response
#### Success Response (200)
- **mPayload** (object) - The payload containing the Ezsign documents and their annotations.
- **objDebugPayload** (object) - Debug information regarding the request.
- **objDebug** (object) - Detailed debug information including memory usage and SQL queries.

#### Response Example
{
  "mPayload": {
    "a_objEzsigndocument": [
      {
        "pkiEzsigndocumentID": 97,
        "sEzsigndocumentName": "Contract #123",
        "a_objEzsignannotation": [
          {
            "pkiEzsignannotationID": 113,
            "fkiEzsigndocumentID": 97,
            "eEzsignannotationHorizontalalignment": "Center",
            "eEzsignannotationVerticalalignment": "Bottom",
            "eEzsignannotationType": "Text",
            "iEzsignannotationX": 50,
            "iEzsignannotationY": 50,
            "iEzsignannotationWidth": 75,
            "iEzsignannotationHeight": 25,
            "sEzsignannotationText": "Sample",
            "iEzsignpagePagenumber": 1,
            "objTextstylestatic": {
              "pkiTextstylestaticID": 216,
              "fkiFontID": 1,
              "sFontName": "Arial",
              "bTextstylestaticBold": true,
              "bTextstylestaticUnderline": true,
              "bTextstylestaticItalic": true,
              "bTextstylestaticStrikethrough": true,
              "iTextstylestaticFontcolor": 3752795,
              "iTextstylestaticSize": 12
            }
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Create Ezsign User Response Sample

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Successful response structure containing email processing results and debug information.

```json
{
  "mPayload": {
    "a_sEmailAddressSuccess": [
      "someone@example.com",
      "someone2@example.com"
    ],
    "a_sEmailAddressFailure": [
      "UserAlreadyExists@example.com"
    ]
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
    ],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      },
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      }
    ]
  }
}
```

--------------------------------

### GET /3/object/ezsignfolder/{pkiEzsignfolderID}

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves an existing Ezsignfolder by its unique ID.

```APIDOC
## GET /3/object/ezsignfolder/{pkiEzsignfolderID}

### Description
Retrieves an existing Ezsignfolder object based on the provided unique identifier.

### Method
GET

### Endpoint
/3/object/ezsignfolder/{pkiEzsignfolderID}

### Parameters
#### Path Parameters
- **pkiEzsignfolderID** (integer) - Required - The unique ID of the Ezsignfolder (>= 0).

### Response
#### Success Response (200)
- Successful response

#### Error Response (404)
- The request failed. The element on which you were trying to work does not exist.
```

--------------------------------

### GET /1/object/ezsigntemplatepackage/getList

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves a list of Ezsigntemplatepackage objects based on provided filters and pagination parameters.

```APIDOC
## GET /1/object/ezsigntemplatepackage/getList

### Description
Retrieve a list of Ezsigntemplatepackage objects. This endpoint supports filtering, sorting, and pagination of the results.

### Method
GET

### Endpoint
/1/object/ezsigntemplatepackage/getList

### Parameters
#### Query Parameters
- **eOrderBy** (string) - Optional - Specify how you want the results to be sorted. Enum: "pkiEzsigntemplatepackageID_ASC", "pkiEzsigntemplatepackageID_DESC", "fkiTeamID_ASC", "fkiTeamID_DESC", "fkiEzsignfoldertypeID_ASC", etc.
- **iRowMax** (integer) - Optional - The maximum number of results to be returned (1-10000).
- **iRowOffset** (integer) - Optional - The starting element from where to start retrieving the results (Default: 0).
- **sFilter** (string) - Optional - The filter to apply to the request to limit results.

#### Header Parameters
- **Accept-Language** (string) - Optional - The language of the returned content. Enum: "*", "en", "fr".

### Response
#### Success Response (200)
- **mPayload** (object) - The payload containing the list of Ezsigntemplatepackage objects and metadata.
- **objDebugPayload** (object) - Debug information related to the request.
- **objDebug** (object) - SQL and performance debug information.
```

--------------------------------

### Branding List Response JSON

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Example of a successful 200 OK response body in JSON format containing the branding objects and debug information.

```json
{
  "mPayload": {
    "a_objBranding": [
      {
        "pkiBrandingID": 78,
        "sBrandingDescriptionX": "Company X",
        "iBrandingColortext": 3752795,
        "iBrandingColortextlinkbox": 0,
        "iBrandingColortextbutton": 16777215,
        "iBrandingColorbackground": 15658734,
        "iBrandingColorbackgroundbutton": 13577007,
        "iBrandingColorbackgroundsmallbox": 16777215,
        "bBrandingIsactive": true
      }
    ],
    "iRowReturned": 100,
    "iRowFiltered": 533
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
    ],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59",
    "a_Filter": {
      "a_AutoType": {
        "property1": "string",
        "property2": "string"
      },
      "a_AutoTypeHaving": {
        "property1": "string",
        "property2": "string"
      },
      "a_Enum": {
        "property1": {
          "property1": "string",
          "property2": "string"
        },
        "property2": {
          "property1": "string",
          "property2": "string"
        }
      }
    },
    "a_OrderBy": {
      "property1": "string",
      "property2": "string"
    },
    "iRowMax": 100,
    "iRowOffset": 0
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      },
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      }
    ]
  }
}
```

--------------------------------

### GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Retrieves an existing Ezsignbulksendtransmission by its unique ID.

```APIDOC
## GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}

### Description
Retrieves an existing Ezsignbulksendtransmission object containing details about a batch of Ezsignfolders.

### Method
GET

### Endpoint
/2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}

### Parameters
#### Path Parameters
- **pkiEzsignbulksendtransmissionID** (integer) - Required - The unique ID of the Ezsignbulksendtransmission (>= 0).

### Response
#### Success Response (200)
- **mPayload** (object) - The payload containing the Ezsignbulksendtransmission object.

#### Response Example
{
  "mPayload": {
    "objEzsignbulksendtransmission": {
      "pkiEzsignbulksendtransmissionID": 21,
      "fkiEzsignbulksendID": 8,
      "sEzsignbulksendtransmissionDescription": "Test eZsign Bulk Send Transmission #1",
      "iEzsignbulksendtransmissionErrors": 1
    }
  }
}
```

--------------------------------

### Request Payload Example

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

The JSON payload required for the createEmbeddedUrl request.

```json
{
  "sReturnUrl": "https://www.example.com",
  "sIframeOrigin": "https://www.example.com"
}
```

--------------------------------

### Import Ezsignfoldersignerassociation Response Sample

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

The structure of the successful 200 response returned by the API.

```json
{
  "mPayload": {
    "a_pkiEzsignfoldersignerassociationID": [
      20
    ]
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
    ],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      },
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      }
    ]
  }
}
```

--------------------------------

### Create Ezsigntemplatepublic Response Sample

Source: https://ezmaxinc.github.io/eZmax-API/docs/partial/ezsign/ezmax.v1.3.html

Successful response structure returned after creating an Ezsigntemplatepublic object.

```json
{
  "mPayload": {
    "a_pkiEzsigntemplatepublicID": [
      96
    ]
  },
  "objDebugPayload": {
    "iVersionMin": 1,
    "iVersionMax": 2,
    "a_RequiredPermission": [
      117
    ],
    "bVersionDeprecated": false,
    "dtResponseDate": "2020-12-31 23:59:59"
  },
  "objDebug": {
    "sMemoryUsage": "11,923MB",
    "sRunTime": "0.6084s",
    "iSQLSelects": 3,
    "iSQLQueries": 6,
    "a_objSQLQuery": [
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      },
      {
        "sQuery": "SELECT * FROM table",
        "fDuration": 0.0001
      }
    ]
  }
}
```
Tokens:
Raw