Versions Compared

Key

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

...

...

...

...

Method description

Delete an equalize setting from an instance.

Security

The calling user must have the EB_ROOT, EB_ADMIN, EB_APP, SEARCH_ADMIN or SEARCH_MANAGER role for this instance or the global instance.

Parameters

None

Response codes

HTTP codeDescription
200Equalize deleted
400The equalize cannot be removed because it is currently enabled
401The user does not meet the security criteria
404Equalize not found

 

Response format

A 200 OK response will contain a single object with the deleted equalize data.

...

a specific equalize for the client {instance_id}.

URI Parameters

None

Responses

200 - item has been deleted

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
    "created_on": "2017-08-08T15:27:54",
    "enabled": false,
    "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 - the item cannot be removed because it is currently enabled

Type: application/json


Code Block
titleExample application/json
collapsetrue
{
  "code": 400,
  "details": "Cannot delete an enabled Equalize. Please enable a different one first",
  "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 or item doesn't exist

Type: application/json

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