====== АННОТАЦИЯ ======
В данном документе приведено описание применения программы «Программный интерфейс взаимодействия системы отображения метеорологических данных измерительной информации», предназначенной для передачи системе отображения метеорологической информации из базы данных.
====== Общие сведения о системе ======
Программный интерфейс входит в состав системы отображения метеорологических данных МФ МГТУ им. Н.Э. Баумана. Основные функции программного интерфейса состоят в получении, передачи и обработке метеорологической информации в формате JSON.
====== Описание решаемой задачи ======
Программный интерфейс работает в режиме 24/7 на сервере мониторинговой системы, ожидая запросы на получение данных. Вместе с программным интерфейсом постоянно работает Redis, который расположен на порте сервера 6379.
====== Входные и выходные данные ======
===== Входная информация =====
Входной информацией для программного интерфейса будет являться GET-запрос по протоколу HTTP к интерфейсу REST. Список всех возможных запросов:
^ Запрос                                   ^ Получаемые данные                                                                                                                                                                                                                                                                                                                                                                             ^
| /not_calibr/log/:fdate/:sdate            | Неоткалиброванные данные в указанный временной промежуток. Необходимо указать начальную дату и время (:fdate), конечную дату и время (:sdate). Пример URL: http://webrobo.mgul.ac.ru:3000/db_api_REST/not_calibr/log/2023-01-01%2000:00:00/2023-01-01%2000:08:00                                                                                                                              |
| /calibr/log/:fdate/:sdate                | Откалиброванные данные в указанный временной промежуток. Необходимо указать начальную дату и время (:fdate), конечную дату и время (:sdate). Пример URL: http://webrobo.mgul.ac.ru:3000/db_api_REST/calibr/log/2023-01-01%2000:00:00/2023-01-01%2000:08:00                                                                                                                                    |
| /not_calibr/log/:fdate/:sdate/:list      | Неоткалиброванные данные в указанный временной промежуток для определенного списка устройств. Необходимо указать начальную дату и время (:fdate), конечную дату и время (:sdate), а также список устройств в параметре "list". Пример URL: http://webrobo.mgul.ac.ru:3000/db_api_REST/not_calibr/log/2023-01-01%2000:00:00/2023-01-01%2000:08:00/Опорный%20барометр@02&Паскаль@01&Паскаль@02  |
| /calibr/log/:fdate/:sdate/:list          | Откалиброванные данные в указанный временной промежуток для определенного списка устройств. Необходимо указать начальную дату и время (:fdate), конечную дату и время (:sdate), а также список устройств в параметре "list". Пример URL: http://webrobo.mgul.ac.ru:3000/db_api_REST/calibr/log/2023-01-01%2000:00:00/2023-01-01%2000:08:00/Опорный%20барометр@02&Паскаль@01&Паскаль@02        |
| /not_calibr/last_measurement_list/:list  | Неоткалиброванные данные за последние 10 минут с определенного списка устройств. Необходимо указать список устройств в параметре "list". Пример URL: http://webrobo.mgul.ac.ru:3000/db_api_REST/not_calibr/last_measurement_list/Опорный%20барометр@02&Паскаль@01&Паскаль@02                                                                                                                  |
| /calibr/last_measurement_list/:list      | Откалиброванные данные за последние 10 минут с определенного списка устройств. Необходимо указать список устройств в параметре "list". Пример URL: http://webrobo.mgul.ac.ru:3000/db_api_REST/not_calibr/last_measurement_list/Опорный%20барометр@02&Паскаль@01&Паскаль@02                                                                                                                    |
===== Выходная информация =====
Выходные данные представлены в виде JSON-записей, ключом каждой из которых является их уникальный номер записи в базе данных, а значением – словарь, включающий в себя общую информацию и измерения.