GET
, POST
, PUT
and DELETE
queries.error
, meta
or data
.data
or meta
key at response object.data
object CAN be an Object or Array of Objects.data
object contain type
and attributes
keys with response object definition.POST
or PUT
query MUST contain a valid JSON Object and use type
of passed object as key for data.user
is type
of passed entity.errors
Object with error details.code
and title
fields, other fields is optional.200 OK
Success Response400 Bad Request
The request was unacceptable, often due to missing a required parameter.401 Unauthorized
No valid Bearer Token provided.403 Forbidden
Access forbidden. User not have rights to call this action.404 Not Found
The requested resource doesn't exist.422 Unprocessable Entity
Validation Error.resource
is requested endpoint, X
- number of requested page, Y
- count of elements at response.page
counted from 1. Max limit
value is 100.meta
section from response:field
is field name for sort, direction
is one of possible values (asc
or desc
).title
field at ascending direction.GET
arguments in the query string under the filter
prefix. Each field should be wrapped into square brackets: filter[field]
. To pass list of possible values, use comma symbol: filter[field]=value1,value2
.=
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][gte]=value
or 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.=
symbol