Status Codes
When the user calls any of the REST resources, the Response header returns one of the standard HTTP status codes defined in the following table.
Table - Standard HTTP Status Codes
| HTTP Status Codes | Message | Details |
|---|---|---|
| 200 | Success |
Success with response body. Most GET requests will receive this response. If no data to empty response body will be sent. |
| 201 | Created | Success with response body. Used with POST URIs where a resource is created in the database. ID of the entity created should be returned. |
| 204 | Success | Success with no response body. Most PUT requests will receive this response. |
| 400 | Bad Request | The server cannot or will not process the request due to a client error such as malformed request syntax, invalid request message framing, or deceptive request routing. To be used if URI syntax is not correct such as wrong format in Q query |
| 401 | Unauthorized | User not authorized |
| 403 | Forbidden | The server denied access to the resource. Please contact System Administrator. |
| 404 | Not Found | Request resource not found |
| 405 | Method not allowed | HTTP action not allowed for the requested API |
| 406 | Not acceptable | The endpoint does not support the response format specified in the request Accept header |
| 415 | Unsupported media type | The endpoint does not support the format of the request body |
Common Error Codes with Incorrect GUID
GET Request
- When a valid GUID (i.e., a GUID in the correct format) is passed in the request but does not exist in the database (i.e., the resource is not found on the server), a 404 - Not Found response should be returned.
- When an invalid GUID (i.e., a GUID in an incorrect format) is passed in the request, a 400 - Bad Request response should be returned.
POST Request
- If a valid GUID (i.e., a GUID in the correct format) is passed in the request but is not found in the database, a 400 - Bad Request response should be returned.
- If an invalid GUID (i.e., a GUID in an incorrect format) is passed in the request, a 400 - Bad Request response should be returned.
- If batch processing of a cycle is requested and no valid pending activities exist, a 200 - OK response should be returned.