Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method description

...

Parameter NameRequiredDescription
rows(error)See: Empathy Play API - Pagination
offset(error)See: Empathy Play API - Pagination
enabled(error)Filter by enabled/disabled state
visible(error)Filter by boost is activated or not on request time
lang(error)Filter by boost language
kw(error)Filter by boost keywords
pkw(error)Filter by boost keywords (partial search)

Responses

200 - successful information retrieve

...

Code Block
titleExample application/json
collapsetrue
{
  "code": 400,
  "details": "\"rows\" must be in range 10-200",
  "message": "Bad Request",
  "status": "error"
}
401 - the user performing the action doesn't meet the security criteria

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": 401,
  "details": "The server could not verify that you are authorized to access the URL requested.  You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
  "message": "Unauthorized",
  "status": "error"
}
404 - the instance doesn't exist or offset is wrong

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": 404,
  "details": "",
  "message": "Not Found",
  "status": "error"
}

See: Empathy Play API - Pagination