Query parameter value processing failed

Status #

400

Meaning #

The API responds with ‘Query parameter value processing failed’ if you’ve executed a GET request against the route …

• /hybrid-core/v1/sites
• /hybrid-core/v1/sites/:site_id/assets

with invalid value of any query parameter.

Finally, you get that response, if the value of any query parameter you’ve used to request respective route doesn’t match the format it is designed to fit in any manner.

Semantically the response status code is equivalent to the HTTP 400 Bad Request response status code. It indicates that the server can’t process your request as well as that a part of the request you’ve send doesn’t fit the defined format in any matter.

On the one hand the 400 error is an error which is interpreted as a server-side problem. On the other hand, from the technical view the error belongs to a client-side issue, because at the moment when the request is fired by the client he should be aware about the value of the query parameters he is using for GET request against given route. This is the reason why this type of error is categorized within the scope of client-side (4xx) responses.

Request #

GET https://api.gridscale.io/hybrid-core/v1/sites?page[offset]=-1

Response #

Header:

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
...

Body:

{
  "errors": [
    {
      "type": "https://my.gridscale.io/docs/apis/problems/hybrid-core/v1/query-parameter-value-processing-failed",
      "title": "Query parameter value processing failed",
      "status": 400,
      "detail": "Request query parameter value is wrong. Value for 'page[offset]' query parameter must be >= 0, but is -1."
      "DocURL": "https://my.gridscale.io/docs/apis/hybrid-core/v1/introduction",
    }
  ]
}