Цифра

Список диспетчерских

Получение списка диспетчерских, привязанных к аккаунту. Возвращает Id, который используется в заказах как dispatch_id.

POST /api/dispatches/list

Метод возвращает список диспетчерских, привязанных к аккаунту по секретному ключу.

Параметры запроса

Параметр Тип Обязательный Описание
SecretKey string Да Секретный ключ

Структура Data[]

Поле Тип Описание
Id integer ID диспетчерской. Совпадает с dispatch_id в заказах (orders/report)
Name string Название диспетчерской
Пример запроса 1С → Цифра
{
  "SecretKey": "2akgzOCYsAxLwpNl"
}
Пример ответа Цифра → 1С
{
  "Message": null,
  "Success": true,
  "Data": [
    {
      "Id": 10,
      "Name": "Диспетчерская Центр"
    },
    {
      "Id": 11,
      "Name": "Диспетчерская Юг"
    }
  ]
}

Коды ответов

Код Описание
200 Успешный ответ. Список диспетчерских получен (Success: true)
403 Ошибка авторизации. Секретный ключ не найден (Success: false)

Структура ответа

Поле Тип Обязательное Описание
Success boolean Да Успешно ли выполнен запрос
Message string Нет Сообщение об ошибке (null если успешно)
Data array Да Массив диспетчерских

Примеры ответов

{
  "Message": null,
  "Success": true,
  "Data": [
    {
      "Id": 10,
      "Name": "Диспетчерская Центр"
    },
    {
      "Id": 11,
      "Name": "Диспетчерская Юг"
    }
  ]
}
{
  "Message": "Секретный ключ не найден",
  "Success": false
}

См. также