Delete announcements

Deletes announcements by ids

application/json

Request Body required

• link_ids uuid[]

  List of unique entity ids

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Deleted
• Not found

---

Schema

• result object[]

  List of entity state responses. Used when deleting announcement, creating, updating, deleting contacts.

  link_id uuid

  Unique entity set by the server to bind some parameters with each other. By default return null value

  success boolean

  Operation result status

  extended_info string

  Possible values: [created, updated, deleted, entity_not_found, invalid_entity_data]

  Entity state information result

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": true,
      "extended_info": "created"
    }
  ]
}

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": true,
      "extended_info": "deleted"
    }
  ]
}

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": false,
      "extended_info": "entity_not_found"
    }
  ]
}

• Missed json body or wrong param. Response sample:

    "error": "Wrong JSON body"
• Required field is not provided. Response sample:

    "error": "Wrong JSON body: no value for `param`"
  where param - is a required field that was not provided
• Field was of the wrong type. Response sample:

    "error": "Wrong JSON body: value `param` was of the wrong type"
  where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Base
• Missed param
• Wrong param type

---

Schema

• error string

  Error information

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error information

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...