Метод применяется для получения расширенного списка терминалов.
Метод запроса: POST/public/terminals/search
Метод доступен по ссылке.
| Атрибут | Тип | Обязательность | Описание |
| ids | UUID[] | Нет | Идентификаторы ТС |
| page | Integer | Нет | Номер страницы |
Пример запроса:
{
"ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"page": 0
}
В случае успеха метод возвращает ответ с кодом 200 и телом ответа в формате JSON:
| Атрибут | Тип | Обязательность | Описание | |
| items | Object[] | Да | Массив результатов | |
| SerialId | String | Да | Серийный номер терминала | |
| FirmwareVersion | String | Нет | Версия прошивки терминала | |
| DeviceRevision | String | Нет | Версия устройства (терминала) | |
| SimNumber | String | Нет | SIM номер терминала | |
| ProtocolName | UUID | Да | Протокол терминала | |
| DeviceTypeName | UUID | Да | Идентификатор типа оборудования терминала | |
| EnableLog | Boolean | Да | Вести логирование | |
| UnitId | UUID | Нет | Идентификатор привязанного ТС | |
| OlsonId | String | Нет | Часовой пояс терминала | |
| FirmwareUpdated | DateTime | Нет | Дата и время последнего обновления прошивки | |
| IMEI | String | Нет | IMEI устройства | |
| Сomment | String | Нет | Комментарий | |
| EquipmentStatus | Enum:
|
Да | Статус оснащения | |
| SimNumber2 | String | Нет | Второй SIM-номер | |
| isBlacklisted | Boolean | Да | Признак чёрного списка | |
| OwnerCompanyId | String | Да | ScopePath компании, которой принадлежит терминал | |
| ScopesWithAccess | String[] | Нет | Набор ScopePath компаний, которым доступен терминал | |
| isLast | Boolean | Да | Признак последней части | |
Пример ответа:
{
"items": [
{
"serialId": "string",
"firmwareVersion": "string",
"deviceRevision": "string",
"simNumber": "string",
"protocolName": "string",
"deviceTypeName": "string",
"enableLog": true,
"unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"olsonId": "string",
"firmwareUpdated": "2026-05-05T07:05:23.837Z",
"imei": "string",
"comment": "string",
"equipmentStatus": "None",
"simNumber2": "string",
"isBlacklisted": true,
"ownerCompanyScopePath": "string",
"scopePaths": [
"string"
]
}
],
"isLast": true
}
В случае ошибок авторизации или валидации запроса метод возвращает код, соответствующий ошибке, и тело в формате JSON, соответствующее формату Problem Details:
| Тело ответа | Тип | Обязательность | Описание | |
| type | String | Да | Тип ошибки | |
| title | String | Да | Человекочитаемая расшифровка типа ошибки (универсальная для всех запросов) | |
| detail | String | Нет | Комментарий к ошибке (специфичный для этого запроса) | |
| errors | Object[] | Нет | Массив детализированных ошибок | |
| key | enum ErrorKey | Да | Тип ошибки | |
| 401 | Unautorized | Токен невалидный или истек срок действия | ||
| 403 | TerminalInaccessible | Нет роли с ApiScope "terminals:read" и доступом к Terminal.OwnerCompanyId или Terminal.ScopesWithAccess | ||
| 400 | Format | Некорректный формат query параметра | ||
| 404 | TerminalNotFound | Запрашиваемый по Id терминал не найден в системе | ||
| 404 | PageNotFound | Запрашиваемая страница не найдена (page меньше минимального значения или page больше максимального значения) | ||
| 500 | InternalError | Произвольная ошибка на сервере | ||
| values | String[] | Да | Список сообщений к данной ошибке | |
Author: Эфендиева Валерия Руслановна - Mon, Apr 20, 2026. This article has been viewed 39 times.
Powered by PHPKB (Knowledge Base Software)