⌂ > 📷 Применение REST API > Работа с базой автономеров

cars-groups : Список групп автомобилей🔗

Важно

Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.

Параметры🔗

Параметр	Описание
offset	Необязательный параметр. Задаёт порядковый номер автомобиля, начиная с которого нужно получить список автомобилей. По умолчанию значение 0
portion	Необязательный параметр. Количество записей об автомобилях, которое нужно получить. По умолчанию 1000, максимальное значение равно количеству записей об автомобилях в базе
filter	<attribute_name> <логический оператора сравнения> '<предполагаемое значение>': <attribute_name> - имя атрибута (поля) сущности (см. Параметры), <логический оператора сравнения> - доступен оператор '=' для поиска вхождения в коллекции; '<предполагаемое значение>' – значение ID, фамилия/имя/отчество, процент (от 0 до 100). Параметр должен соответствовать URL encoding. Фильтры можно комбинировать с помощью оператора “AND” (см. пример Примеры)
dbid	Необязательный параметр. Доступен только для модуля Распознавание автономеров (Complete). Идентификатор базы автономеров. При указании идентификатора выполняется действие с уникальной базой, которая соответствует идентификатору. Если параметр не указан, то выполняется действие с общей базой. Идентификатор уникальной базы должен быть длиной не более 32-х символов, содержать латинские буквы, цифры и нижнее подчеркивание

Описание параметра filter🔗

Параметры🔗

Параметр	Описание
external_id	Идентификатор из стороннего ПО, интегрированного с Macroscop
external_sys_id	Идентификатор стороннего ПО, интегрированного с Macroscop. Используется функционалом синхронизации базы с внешней системы. Максимальная длина 64 символа

Примеры🔗

Пример запросов с фильтрацией:

http://localhost:8080/api/cars?offset=0&portion=50&filter=external_id='123'

Пример запроса с несколькими фильтрами:

http://localhost:8080/api/cars?offset=0&portion=50&filter=group_id='05a21 e32-51e5-405e-b4cf-3082796c8703' AND group_id='2090779b-9091- 4989-a5f8-92d1920d8291'

Предупреждение

В фильтре нельзя задавать сразу несколько значений для одного и того же параметра, если это параметр first_name, last_name, patronymic.

Пример отображение в URL encoding:

http://localhost:8080/api/cars?offset=0&portion=50&filter=group_id%3D%2 705a21e32-51e5-405e-b4cf-3082796c8703%27

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

GET http://localhost:8080/api/cars-groups?offset=0&portion=10

Пример ответа🔗

{
    "offset": 0,
    "portion": 3,
    "total_count": 3,
    "groups": [
        {
        "id": "8d7223c9-b9ff-42b8-8fe8-ec7c5a6efa67",
        "external_id": "",
        "name": "Доверенная",
        "intercept": false,
        "open_barrier": false,
        "modification_time": "2021-02-14T02:26:01.423Z"
        "external_sys_id": ""
        },
        {
        "id": "fbf579b5-b171-40ea-acd7-e4680ce3b962",
        "external_id": "",
        "name": "Перехват",
        "intercept": true,
        "open_barrier": false,
        "modification_time": "2021-02-14T02:26:01.423Z"
        "external_sys_id": ""
        },
        {
        "id": "976cff8b-6ad3-4153-bf57-3321836c8006",
        "external_id": "",
        "name": "Открытие шлагбаума",
        "intercept": false,
        "open_barrier": true,
        "modification_time": "2021-02-14T02:26:01.423Z"
        "external_sys_id": ""
        }
    ]
}

Примечание

modification_time - время в UTC, когда автомобиль был добавлен или обновлен в базе автономеров.