Skip to main content

DELETE - Удаление чек-листа по ID

Эндпоинт DELETE /check-lists/{id} используется для удаления чек-листа по его уникальному идентификатору (ID).

Детали запроса​

  • Метод: DELETE
  • Эндпоинт: /check-lists/{id}
  • Заголовки:
    • Authorization: Требуется токен доступа.
    • Content-Type: application/json
  • Параметр пути:
    • id (строка, обязательно): Уникальный идентификатор чек-листа (UUID).

Пример запроса​

URL​

https://api.targpatrol.com/v1/check-lists/be63c536-6cf3-4866-8970-37a956e3f403

Пример на Python​

import requests

# URL API с ID чек-листа
url = "https://api.targpatrol.com/v1/check-lists/be63c536-6cf3-4866-8970-37a956e3f403"

# Заголовки
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json",
}

# Отправка DELETE-запроса
response = requests.delete(url, headers=headers)

# Обработка ответа
if response.status_code == 204:
    print("Чек-лист успешно удалён.")
else:
    print(f"Ошибка: {response.status_code}, {response.json()}")

Обработка ошибок​

1. Неверные входные данные​

Возникает, если предоставленный id не соответствует формату UUID.

Ответ:​

{
  "message": "invalid input data",
  "code": "input.data.invalid",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "invalid data type",
      "code": "data.type.invalid",
      "identifier": "id",
      "args": [
        "[UUID]"
      ]
    }
  ]
}

Решение:​

Убедитесь, что id соответствует правильному формату UUID, например: be63c536-6cf3-4866-8970-37a956e3f403.

2. Ресурс не найден​

Возникает, если чек-лист с указанным id не существует.

Ответ:​

{
  "message": "resource wasn't found",
  "code": "not.found",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Решение:​

Проверьте, что чек-лист с указанным id существует в системе.

3. Внутренняя ошибка сервера​

Возникает из-за технических проблем на стороне сервера.

Ответ:​

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Решение:​

Повторите запрос позже или обратитесь в техническую поддержку.

Итог​

Эндпоинт DELETE /check-lists/{id} позволяет безопасно удалить чек-лист из системы. Корректная обработка ошибок обеспечивает надёжную интеграцию и снижает вероятность неправильного использования.