Skip to main content

GET - Детали чек-листа по ID

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

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

  • Метод: GET

  • Эндпоинт: /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",
}

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

# Обработка ответа
if response.status_code == 200:
    checklist = response.json()
    print("Детали чек-листа:", checklist)
else:
    print(f"Ошибка: {response.status_code}, {response.json()}")

Пример успешного ответа​

  • Код состояния: 200 OK
  • Тело ответа:
{
  "id": "be63c536-6cf3-4866-8970-37a956e3f403",
  "name": "Kitchen list 1",
  "actionIds": [
    "1cea9223-e7d4-4b12-becc-9482afd7999d",
    "ed13f992-7de6-4f0d-b77f-baa47ae00ec9"
  ],
  "tags": [
    "kitchen"
  ]
}

Поля ответа​

  • id (строка): Уникальный идентификатор чек-листа.
  • name (строка): Название чек-листа.
  • actionIds (массив): Список идентификаторов действий (UUID), входящих в чек-лист.
  • tags (массив): Теги, связанные с чек-листом.

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

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

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

Итог​

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