Not allowed query parameter

Status #

400

Meaning #

The API responds with ‘Not allowed query parameter’ if you’ve executed a request against the route …

• /hybrid-core/v2/hybrid-cores
• /hybrid-core/v2/hybrid-cores/:hybrid_core_id/assets

with invalid query parameter(s). Finally, you get that response, if the query parameter(s) you’ve used to request respective route isn’t/aren’t defined for that route.

Semantically the response status code is equivalent to the HyperText Transfer Protocol (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.

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 query parameters he is using for 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/v2/hybrid-cores?filter[foo]=3

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/v2/not-allowed-query-parameter",
      "title": "Not allowed query parameter",
      "status": 400,
      "detail": "Allowed pagination query parameters: [page[limit] page[offset]]. Allowed filter query parameters: [filter[id] filter[public_available] filter[status]].",
      "invalid-params": [
            {
            "name": "filter[foo]",
            "reason": "Not allowed query parameter."
            }
       ],
      "DocURL": "https://my.gridscale.io/docs/apis/hybrid-core/v2/introduction",
    }
  ]
}