/<instance_id>/synonyms - GET

Method description

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

URI Parameters

Parameter name	Required	Description
rows		See: Empathy Play API - Pagination
offset		See: Empathy Play API - Pagination
enabled		Filter by enabled/disabled state
lang		Filter by synonym language
kw		Filter by synonym keywords
pkw		Filter by synonym keywords (partial search)

Response format and codes

200 - successful information retrieve

Type: application/json

Example application/json

{
  "num_found": 78,
  "results": [
    {
      "alternatives": null,
      "batched": false,
      "created_on": "2017-08-08T15:27:29",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d8611f3319000b833519",
      "lang": "en",
      "synonyms": [
        "lemon",
        "banana",
        "yellow"
      ],
      "type": "color",
      "updated_on": "2017-08-08T15:27:29"
    },
    {
      "alternatives": null,
      "batched": false,
      "created_on": "2017-08-08T15:27:29",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d861e6ece90012a92752",
      "lang": "en",
      "synonyms": [
        "cyan",
        "azure",
        "navy",
        "blues",
        "sky",
        "blue"
      ],
      "type": "color",
      "updated_on": "2017-08-08T15:27:29"
    },
    {
      "alternatives": null,
      "batched": false,
      "created_on": "2017-08-08T15:27:29",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d861e6ece90012a92753",
      "lang": "en",
      "synonyms": [
        "snow",
        "white",
        "ivory"
      ],
      "type": "color",
      "updated_on": "2017-08-08T15:27:29"
    },
    {
      "alternatives": null,
      "batched": false,
      "created_on": "2017-08-08T15:27:29",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d8611f3319000c833517",
      "lang": "en",
      "synonyms": [
        "wheat",
        "camel",
        "beige"
      ],
      "type": "color",
      "updated_on": "2017-08-08T15:27:29"
    },
    {
      "alternatives": null,
      "batched": false,
      "created_on": "2017-08-08T15:27:29",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d8611f3319000b83351a",
      "lang": "en",
      "synonyms": [
        "gray",
        "stone",
        "smoke",
        "grey",
        "slate"
      ],
      "type": "color",
      "updated_on": "2017-08-08T15:27:29"
    },
    {
      "alternatives": null,
      "batched": false,
      "created_on": "2017-08-08T15:27:30",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d8621f3319000c833518",
      "lang": "en",
      "synonyms": [
        "chocolate",
        "tanned",
        "wood",
        "brown",
        "tan"
      ],
      "type": "color",
      "updated_on": "2017-08-08T15:27:30"
    },
    {
      "alternatives": null,
      "batched": false,
      "created_on": "2017-08-08T15:27:30",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d862e6ece90012a92754",
      "lang": "en",
      "synonyms": [
        "maroon",
        "purple",
        "magenta",
        "lavender",
        "violet",
        "raspberry"
      ],
      "type": "color",
      "updated_on": "2017-08-08T15:27:30"
    },
    {
      "alternatives": null,
      "batched": false,
      "created_on": "2017-08-08T15:27:30",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d862e6ece90011a92759",
      "lang": "en",
      "synonyms": [
        "night",
        "black",
        "dark"
      ],
      "type": "color",
      "updated_on": "2017-08-08T15:27:30"
    },
    {
      "alternatives": null,
      "batched": false,
      "created_on": "2017-08-08T15:27:30",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d862e6ece90012a92755",
      "lang": "en",
      "synonyms": [
        "golden",
        "gold"
      ],
      "type": "color",
      "updated_on": "2017-08-08T15:27:30"
    },
    {
      "alternatives": null,
      "batched": false,
      "created_on": "2017-08-08T15:27:30",
      "enabled": true,
      "extra": {
        "user": "-"
      },
      "id": "5989d8621f3319000c833519",
      "lang": "en",
      "synonyms": [
        "orange",
        "copper",
        "sun",
        "rust",
        "oranges"
      ],
      "type": "color",
      "updated_on": "2017-08-08T15:27:30"
    }
  ]
}

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"
}

See: Empathy Play API - Pagination