Errors
In addition to a JSON error response object, errors in WEBCON BPS are returned using standard HTTP status codes. The error response is a single JSON object that contains three important parameters:
- Error guid – is correlated with ID, that can be found in db tables [dbo].[AdminAPILogs] and [dbo].[AdminWFEventLogs] along with request and detailed error information
- Description – is a developer message about an error that has occurred. This should not be displayed directly to the user.
- Type – is an error code string for the error that occurred.
Example error object:
{
"type": "InvalidAuthenticationToken",
"description": "Authentication token is invalid or has expired.",
"errorGuid": "0a92939c-bd75-4cf7-8392-41776f9bf63b"
}
The following table contains the HTTP status codes that can be returned.
| Type | HTTP status code | Error type description |
|---|---|---|
| InvalidInput | 400 | One of the request inputs is not valid. |
| InvalidQueryParameterValue | 400 | An invalid value was specified for one of the query parameters in the request URI. |
| InvalidBodyParameterValue | 400 | An invalid value was specified for body parameter in the request. |
| MissingRequiredBodyParameter | 400 | A required body parameter was not specified for this request. |
| MissingRequiredQueryParameter | 400 | A required query parameter was not specified for this request. |
| UnsupportedHeader | 400 | One of the HTTP headers specified in the request is not supported. |
| AuthenticationFailed | 401 | Server failed to authenticate the request. Make sure the value of the Authorization header is formed correctly. |
| InvalidAuthenticationToken | 401 | Authentication token is invalid or has expired. |
| LicenseError | 402 | The limit of granted licenses has been exceeded or no license is associated with the user. |
| InsufficientAccountPermissions | 403 | The account being accessed does not have sufficient permissions to execute this operation. |
| InvalidScope | 403 | The auth token does not contain required scope. |
| ResourceNotFound | 404 | The specified resource does not exist. |
| UnsupportedOperation | 405 | The resource doesn’t support the specified operation. |
| UnsupportedInstallationType | 405 | Current instalation type is not supported. |
| InvalidFieldData | 409 | Specified field data is invalid. |
| WorkflowValidationError | 409 | Operation caused worklow validation error. |
| UnsupportedContentType | 415 | Specified content type is not supported on selected endpoint. |
| ResourceLocked | 423 | The resource that is being accessed is locked. |
| InternalError | 500 | The server encountered an internal error. Please retry the request. |