Versions Compared

Old Version 9

changes.mady.by.user Jose Manuel Santorum Bello

Saved on

compared with

New Version Current

changes.mady.by.user Roberto Fernández

Saved on

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
{
  "num_found": 913,
  "results": [
    {
      "activation_date": null"2016-10-25T22:00:00",
      "created_on": "2017-08-08T15:27:4352",
      "deactivation_date": null"2017-04-25T22:00:00",
      "enabled": truefalse,
      "extra": {
        "user": "-"
      },
      "id": "5989d86fe6ece90012a927665989d878e6ece90011a9276c",
      "image_url": null,
      "keywords": [
        "rafflering"
      ],
      "langlangs": "en",
[
     "match_all": false,       "titleen":
"Raffle",       "type": "DIRECT"],
      "updated_onreferences": "2017-08-08T15:27:43",
   [
  "url": "http://empathybroker.com/raffle",
      "weight": 0
    },
    {
      "activation_date": null,       "created_on"ref": "2017-08-08T15:27:4419430508",
      "deactivation_date": null,
      "enabledtitle": true,
      "extra": {"Eternity Ring"
        "user": "-"
      },
  
   "id": "5989d870e6ece90012a92767",       "image_url": null,
      "keywords": [
        "returns",
        "return"
      ],
      "lang": "en",
      "match_all": false,
      "title": "Returning goods",
      "type": "PROMOTED",
      "updated_on": "2017-08-08T15:27:4452",
      "urlzero_results": "http://empathybroker.com/delivery-info",
      "weight": 9false
    },
    {
      "activation_date": "20152016-1210-20T0015T00:00:00",
      "created_on": "2017-08-08T15:27:4453",
      "deactivation_date": "20152017-1210-25T0015T00:00:00",
      "enabled": falsetrue,
      "extra": {
        "user": "-"
      },
      "id": "5989d8701f3319000c8335285989d8791f3319000c833529",
      "image_url": null,
      "keywords": [
        "kidsyellow"
      ],
      "langlangs": "en",
      "match_all": false,[
        "titleen":
"http://empathybroker.com/children/partywear/boys",       "type": "DIRECT"],
      "updated_onreferences": "2017-08-08T15:27:44",[
      "url": "http://empathybroker.com/children/partywear/boys",
      "weight": 0
    },
    {
      "activation_date": null,
      "created_on"ref": "2017-08-08T15:27:44",
      "deactivation_date": null11211043",
      "enabled": true,
      "extra": {
        "user"title": "-"Baby Clarabella Lace     },
      "id": "5989d8701f3319000b83352f",Print Dress"
       "image_url": "https://preassets.empathybroker.com/images/4edaf2aa-b2ac-460c-b6d1-5d7a172e89f", }
      "keywords": [
        "trousers"
      ],
      "lang": "en",
      "match_all": false,
      "title": "trousers",
      "type": "BANNER",
      "updated_on": "2017-08-08T15:27:4553",
      "urlzero_results": "http://www.google.es",
      "weight": 9false
    }
  ]
}
400 - Invalid parameters. Error response will include details

...

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