API для интеграции Стационар - ИЭМК представляет собой CRUD приложение, позволяющее добавлять, получать, обновлять и удалять данные по госпитализациям пациентов.
API представлена набором сервисов, которые работают с моделями посредством передачи запросов GET, PUT, POST и DELETE на адреса соответствующих контроллеров.
Используемые модели бывают двух видов - сущности и справочники, что отмечено в описании каждой модели.
Контроллеры сущностей принимают запросы GET, PUT, POST и DELETE - запись можно получить из БД, изменить, вставить новую и удалить.
Контроллеры справочников принимают только запросы GET, так как записи справочников доступны API только на чтение, попытки удалить, изменить или добавить вернут ошибку.
Блок "схема взаимодействия" описывает механизмы передачи данных между стационарами и ИЭМК.
Блок "модели интеграции" описывает все модели, используемые в работе API, с полным перечислением всех полей, их типов, иерархией вложенности и адресов контроллеров, которые принимают запросы к этим моделям.
Блок "методы интеграции" описывает порядок работы с сервисами АПИ для передачи, редактирования и обновления данных.
Блок "авторизация в методах интеграции" описывает правила, по которым необходимо передать системе данные по авторизации для доступа к сервисам.
Блок "тестирование интеграции" представляет собой набор тестовых запросов, которые показывают примеры работы с сервисами интеграции.