Troubleshooting

This article goes over some common errors that the Monitor ERP server might produce when interacting with the API.

General

These are general failure states that are not specific to commands or queries.

Monitor.API is not available

HTTP/1.1 403 Forbidden

"Monitor.API is not available for this system"

This error occurs on any request to an API endpoint in case the customer system does not have the API option enabled.

Unhandled exception

HTTP/1.1 500 Internal Server Error

This error occurs if an unhandled exception is triggered in the server.

Invalid session id

HTTP/1.1 401 Unauthorized

This occurs if the X-Monitor-SessionId header is either not set or if it contains a session identifier that is not valid.

See Authentication for more information.

Suspended session

HTTP/1.1 403 Session suspended

This occurs if another person has authenticated as the user your session belongs to as there can only be one active session per user at a time.

Commands

These failure states can only occur when sending commands to the API via POST requests.

Command not found

HTTP/1.1 404 Not Found

This occurs when the command you requested could not be found. Verify the command URL against the reference documentation and make sure that it is correct.

Validation failure

HTTP/1.1 400 Bad Request

"Validation failed for command {command}: {message}"

This occurs when the command handler determines that something is wrong with the input data. The message in the response body will contain more information.

Entity not found

HTTP/1.1 404 Not Found

"{entity} {business key identifier} was not found..."

This occurs when the command handler attempts to retrieve an entity that does not exist when processing a command.

Conflict

HTTP/1.1 409 Conflict

This occurs when a command attempts to save an entity that has changed since it was first read by the command processor. This can usually be resolved by sending the command again.

Queries

These failure states can only occur when querying the API via GET requests.

Entity not found

HTTP/1.1 404 Not Found

This occurs when the query provider or entity cannot be found.

Invalid identifier

HTTP/1.1 400 Bad Request

"Id is not a valid identifier"

This occurs when the id parameter of the query cannot be converted to a long value.

Invalid filter clause

HTTP/1.1 400 Bad Request

"One or more problems were encountered when parsing the filter: {error}"

This occurs when an invalid filter clause is provided on the $filter parameter of the query.