Frequently Asked Questions

• Why is a READ query?primarykey={id} less efficient than READ query/{id}?

  The Assent API is a collection of RESTful services. Hence query?primarykey={id} and query/{id} are different endpoints. Query?primarykey={id} fetches all items and then filters on primarykey. Query/{id} fetches the item from the database directly.

• What HTTP Status Codes are used?

  200 OK: Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action

  201 Created: The request has been fulfilled, resulting in the creation of a new resource

  202 Accepted: The request has been accepted for processing, but the processing has not yet completed. The request may be eventually acted upon, but could be disallowed when processing occurs.

  400 Bad Request: The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax, size too large, invalid request message framing, or deceptive request routing)

  401 Unauthorized : Authentication is required and has failed or has not yet been provided.

  403 Forbidden: The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort.

  404 Not Found: The requested resource could not be found but may be available in the future. Subsequent requests by the client are permissible.

  405 Method Not Allowed: A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.

  408 Request Timeout: he server timed out waiting for the request. According to HTTP specifications: "The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time.

  429 Too Many Requests : The user has sent too many requests in a given amount of time. Intended for use with rate-limiting schemes.

  500 Internal Server Error: A generic error message, given when an unexpected condition was encountered and no more specific message is suitable

  501 Not Implemented: The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).[63]

  502 Bad Gateway: The server was acting as a gateway or proxy and received an invalid response from the upstream server

  503 Service Unavailable: The server is currently unavailable (because it is overloaded or down for maintenance). Generally, this is a temporary state.

  504 Gateway Timeout: The server was acting as a gateway or proxy and did not receive a timely response from the upstream server

  HTTP Version Not Supported: The server does not support the HTTP protocol version used in the request