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

cars : Список автомобилей🔗

Важно

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

Параметры🔗

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

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

Параметры🔗

Параметр	Описание
group_id	Фильтрация по ID группы
first_name	Фильтрация по имени
last_name	Фильтрация по фамилии
patronymic	Фильтрация по отчеству
license_plate_number	Фильтрация по номеру автомобиля
required_ratio	Необходимый процент совпадения Ф.И.О. или номера автомобиля, чтобы включить автомобиль в выборку (целое число от 0 до 100, по умолчанию 100). Чем больше значение, тем строже будет поиск
external_id	Идентификатор из стороннего ПО, интегрированного с Macroscop
external_sys_id	Идентификатор стороннего ПО, интегрированного с Macroscop. Используется функционалом синхронизации базы с внешней системы. Максимальная длина 64 символа
external_owner_id	Идентификатор владельца из стороннего ПО, интегрированного с Macroscop. Может быть использован при интеграции с внешними системами в задаче с двухфакторной аутентификации. Идентификатора владельца, может быть не уникален. У одного человека может быть несколько машин, но один «пропуск» (например, в Parsec). Максимальная длина 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?offset=0&portion=50

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

{
"offset": 0,
"portion": 2,
"total_count": 2,
"plates": [
{
    "id": "74d8b8cb-ca9c-4a6f-af8c-f990dad24325",
    "external_id": "",
    "license_plate_number": "О529КН70",
    "additional_info": "Доп инфо",
    "modification_time": "0001-01-01T00:00:00"
},
{
    "id": "c25ddd15-53a3-47f4-8471-3b5425a983f9",
    "external_id": "",
    "license_plate_number": "К999УВ70",
    "additional_info": "Нет",
    "modification_time": "0001-01-01T00:00:00"
}
]
}

Примечание

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