| Info | ||
|---|---|---|
| ||
Please note that this documentation and the links refer to the api v6. For more information please see the migration guide and the documentation related to v5. |
...
Please see the next sample authorization (Bearer token):
| Key | Value |
|---|---|
| "Authorization" | e.g. "Bearer asdfngtmvv8pfmsuaxpzz85zux3e63dd9zttrwitx9mln6qka6tds83du3p3lroe" |
Please see the next sample authorization (api token):
| Key | Value |
|---|---|
| "ApiToken" | "asdfngtmvv8pfmsuaxpzz85zux3e63dd9zttrwitx9mln6qka6tds83du3p3lroe" |
...
In general, our REST endpoint returns different HTTP status codes:
| Status Code | Description | Example |
|---|---|---|
| 200 |
...
- 400 BadRequest (envelope description is incorrect)
- 401 Unauthorized (User is not authorized)
- 404 NotFound
- 415 UnsupportedMediaType
...
| Request has been processed successfully. | Envelope has been deleted | |
| 400 | The request cannot be processed. | Missing required value |
| 401 | Required Authorization has not been successful | API Token is expired, user is not active |
| 403 | Authorization is provided and valid, but the called method requires additional permissions | User does not have required permissions (Roles and Permissions) |
| 404 | Main resource for request could not be found or is not accessible | EnvelopeId is not known |
| 500 | Generic server errors | Depending Service is not available |