metakey at response object.
dataobject CAN be an Object or Array of Objects.
attributeskeys with response object definition.
PUTquery MUST contain a valid JSON Object and use
typeof passed object as key for data.
typeof passed entity.
errorsObject with error details.
titlefields, other fields is optional.
200 OKSuccess Response
400 Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 UnauthorizedNo valid Bearer Token provided.
403 ForbiddenAccess forbidden. User not have rights to call this action.
404 Not FoundThe requested resource doesn't exist.
422 Unprocessable EntityValidation Error.
resourceis requested endpoint,
X- number of requested page,
Y- count of elements at response.
pagecounted from 1. Max
limitvalue is 100.
metasection from response:
fieldis field name for sort,
directionis one of possible values (
titlefield at ascending direction.
GETarguments in the query string under the
filterprefix. Each field should be wrapped into square brackets:
filter[field]. To pass list of possible values, use comma symbol:
=mean comparison operator is equal if single value passed or is includes if list of values passed. But you can use other operators, like greater then or less then by passing it as second argument for filter:
filter[field][lte]=value. You can use more then one comparison operator for one field, to build conditions like DATE greater then 2019-01-01 and less then 2019-02-01.