Передаваемый файл может быть двух форматов:
- Простой CSV-файл, в котором будет храниться информация по точкам, в рамках которых нужно выполнить задания.
- ZIP архив, в котором будет храниться больше информации чем в CSV-файле.
Формирование заданий при помощи простого CSV-файла
Для формирования файла может использоваться простой текстовый редактор, либо сторонние приложения работающие с форматом CSV.
Внутри файла должна храниться информация о точках, по которым требуется производить обход. Структура файла должна быть стандартной для CSV – документа. Разделителем должен быть символ: «;» (точка с запятой).
Ibis;56.132897;47.242859;Hotel; Chuvashia Hotel;56.131228;47.245121;Hotel;
Строка файла состоит из:
- Адрес – всегда обязательно.
- Широта — число, десятичный разделитель должен быть точкой («.»).
- Долгота — аналогично «Широте».
- Описание – описание задания. Для формирования «составного описания» смотреть соответствующий пункт ниже.
- Внешний идентификатор — любая строка.
- Необязательные дополнительные параметры через точку запятую («;»). Предназначены для подстановки в описание.
Формирование составного описания
Ibis;56.132897;47.242859;{5}, {6};;Hello;World!!!
Результатом будет следующее описание:
Hello, World!!!
Формирование заданий при помощи ZIP-файла
Данный тип вложение может содержать следующие файлы:
- readme.txt – описание маршрута
- points.csv — список точек в формате csv
- tags.csv — cписок дополнительных справочников в формате csv
- settings.csv — дополнительные настройки в формате csv
- [layout].txt — формы заданий в формате txt
- id.txt — идентификатор маршрута. Может быть не указан, но будет полезен при повторном выполнении задания. Рекомендуется записывать в файл UUID
Простой текстовый файл, в котором храниться информация по маршруту – его описание.
В файл требуется записывать UUID значение, чтобы гарантировать уникальность. Для нового формата данных стал обязательным.
Аналогичен файлу «Простой CSV» – документ с заданиями.
Специальный файл, в котором может храниться дополнительная информация для выпадающих списков и шаблонов форм:
Default;DEFAULT;template User Profile;PROFILE;template
Состоит из:
- Наименование
- Имя параметра, а текущем случаи имя шаблона формы
- Группа
По умолчанию указывается для привязки форм к маршруту.
Файл для передачи дополнительных настроек для маршрута:
GEO;true GEO_QUALITY;HIGH IMAGE;true IMAGE_QUALITY;0.6 IMAGE_HEIGHT;1080
Состоит из:
- Ключ
- Значение
| Наименование | Описание | Замечание |
|---|---|---|
| GEO | Признак обязательности гео-метки в результате | true|false |
| GEO_QUALITY | Предполагаемая точность координаты | HIGH|LOW |
| IMAGE | Признак обязательности изображения в результате | true|false |
| IMAGE_QUALITY | Качество изображения при сжатии | от 0 до 1 |
| IMAGE_HEIGHT | Высота изображения для сохранения результат | 480|720|1080|2160 |
Информация храниться в документе с форматом *.txt и должна быть оформлена в соответствующем формате.
Каждая форма содержится в отдельном файле и именуется в виде константы, которая должна быть отображена в справочнике – tags.csv
Пример наименования шаблона формы
DEFAULT.txt