Standard Operating Procedure
sop-http-status-3.0.0
HTTP Status
These standards are a simplification of a restful API aproach. The restful API aproach should always be considered if necessary complementation to the expressed minimalistic approach is not sufficient.
200 - Success
The 200 Success status response code indicates that the request has succeeded.
400 - Bad Query
The 400 Bad Request status response code indicates that the server can not, or will not, process the request due to unexpected input.
The response must indicate a descriptive reason to the error code, and how the client can solve the problem.
The request should be retried after the client has solved the indeicated problem.
401 - Unauthorized
The 401 Unauthorized status response code indicates that the client request is not authorized to the requested resource.
The request should not be retried.
403 - Forbidden
The 403 Forbidden status response code indicates that the client is not allowed to access the requested resource.
The client could be allowed access to the resource after a fullfilled authentication process.
404 - Not Found
The 404 Not Found status response code signifies that the requested endpoint does not exist. This response can also be employed to indicate the absence of a specific resource, in which case a message should be provided to clarify the distinction between the two ambiguous meanings.
Collection pages are expected to return an empty array instead of a 404, if the result is empty.
The request should not be retried.
412 - Precondition Failed
The 412 Precondition Failed status response code indicates that the access to the targeted resource has ended before completing due to preconditional failure, such as problem comunicating with a dependent upstream service.
The request can be retried by the client.
500 - Server Error
The 500 Server Error status response code indicates an unexpected error.
The request should not be retried without being manually inspected, due to the unexpected nature of the status code.
502 - Bad Gateway
The 502 Bad Gateway status response code indicates an error in the gateway, before the server was reached.
The request can be retried by the client.
503 - Service Unavailable
The 503 Service Unavailable status response code indicates that the gateway could not access the expected upstream service.
The request can be retried by the client.
504 - Gateway Timeout
The 504 Gateway Timeout status response code indicates that the server where not able to complete the request within the expected timeframe.
The request should not be retried.