Error Responses

Fail Fast

TruckMate’s REST APIs follow the fail fast principle. The API Server makes use of the OpenAPI specification to validate input prior to moving onto database and business logic validations. If any failures are found no further processing will be performed.

1. Path Validation

Ensure that the URL path of the API request is correctly formatted, meeting the expectations of the API endpoint.

2. Authentication and Authorization

Verify the identity of the client making the API request, ensuring the necessary credentials allow to access the requested resource. Ensure the authenticated client has the appropriate permissions for the requested endpoint and method.

3. Query String Validation

All query string parameters sent with the request will be validated to ensure that the endpoint supports the parameter, and the parameter supports the value.

4. OpenAPI Schema Validation

Before processing, an initial introspection will be conducted to consolidate any OpenAPI-related errors. If the request deviates from the corresponding OpenAPI specification, a comprehensive summary of all problems will be included in the response body as part of the errors array.

5. Business Logic and Database Value Validations

Business logic errors will be return individually. Business logic errors often require SQL statements to be run, in favor of performance and to minimize the SQL statements run, the first error found will end processing and return the error response to the user.

Error Messages

Errors are returned using standard HTTP Response Codes. Any additional information pertaining to the error will be included in the response body. Please see below table containing the list of currently used error codes and their associated messages: