Errors

HTTP Response Codes

In addition to detailed error messaging, RocketCOMS uses standard HTTP response codes to indicate the status of a request. In general, codes can indicate a successful response (2xx range) or a failed response due to the content or structure of the request (4xx range). Most failed responses fall in the 4xx range due to missing/incorrect request parameters or missing/invalid authentication information.

Common HTTP response codes include:

200 OK The request was successful.

201 OK The request was successful and resulted in the creation of a resource.

204 OK The request was successful and resulted in the deletion of a resource.

400 Bad Request The request could not be processed due to missing or incorrect information (for example, a required parameter is missing).

401 Unauthorized The client can’t be authenticated (the access token is missing or invalid).

403 Forbidden The client has been authenticated but doesn’t have the required permissions to perform the request.

404 Not Found The requested resource or endpoint can’t be found.

Detailed Error Messages

RocketCOMS detailed error messages use the following structure:

{

"status": String,

"traceId": String,

"message": String,

"timestamp": DateTime

}

status Error code.

traceID UUID used to trace the error in the RocketCOMS logs.

message Description of the error.

timestamp Date and time the error occurred.