/<instance_id>/equalize - GET

Method description

Get a list of equalizes for the client {instance_id}. The result list is paginated.

URI Parameters

Parameter NameRequiredDescription
rows(error)See: Empathy Play API - Pagination
offset(error)See: Empathy Play API - Pagination
enabled(error)Filter by enabled/disabled state

Response format and codes

200 - successful information retrieve

Type: application/json

Example application/json
{
  "num_found": 7,
  "results": [
    {
      "created_on": "2017-08-08T15:27:54",
      "enabled": true,
      "extra": {
        "ebwar_id": 1410425211159,
        "notes": "",
        "user": "-"
      },
      "fields": [
        {
          "boost": 1,
          "field": "material"
        },
        {
          "boost": 1,
          "field": "brand"
        },
        {
          "boost": 8,
          "field": "name"
        },
        {
          "boost": 1,
          "field": "condition"
        },
        {
          "boost": 1,
          "field": "colour"
        },
        {
          "boost": 5,
          "field": "categories"
        },
        {
          "boost": 1,
          "field": "description"
        },
        {
          "boost": 1,
          "field": "style"
        },
        {
          "boost": 1,
          "field": "types"
        },
        {
          "boost": 1,
          "field": "gender"
        }
      ],
      "id": "5989d87a1f3319000c83352a",
      "title": "Enhanced on Name followed by Categories",
      "updated_on": "2017-08-08T15:27:54"
    }
  ]
}
400 - Invalid parameters. Error response will include details

Type: application/json

Example application/json
{
  "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

Example application/json
{
  "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

Example application/json
{
  "code": 404,
  "details": "",
  "message": "Not Found",
  "status": "error"
}

SeeEmpathy Play API - Pagination