6.2 Get Enabled Signing Types
6.2.1 Description
This call retrieves the list of signing types that have been enabled in the eSignatures Configuration Index and are thus available in the eSignatures Portal. While section 9. Signing Types lists all possible signing types, this call returns only those signing types for which the IsEnabled flag is set to “On” and the signing type configuration is complete.
This call is useful for integrators who need to know which signing types are currently enabled in a given eSignatures installation, otherwise that list of signing types would need to be duplicated in the integrator’s configuration database as well.
6.2.2 URL
https://[servername]:[port]/webportalapi/v3/signingtypes
6.2.3 HTTP Method
GET
6.2.4 MIME Type
application/json
6.2.5 Response parameters
Parameter | Content / Description | Type |
---|---|---|
SigningTypes | List of enabled signing types | Array of objects |
Parameter | Content / Description | Type |
---|---|---|
SigningTypes (array of objects) | Array, 1..* | |
Name | Name of the signing type for use in Set Process Information or Create Instant package calls. | String |
6.2.6 Example response
{
"EnabledSigningTypes":
[
{
"Name": "Manual"
},
{
"Name": "BeId"
}
]
}
6.2.7 Response codes
Response status code | Description |
---|---|
200 OK | The signing types list gets returned successfully. |
6.2.8 Error codes
HTTP Code | Code |
---|---|
None | No errors |