| Table of Contents |
|---|
Purpose
This WS allows to update a previously created license for a legal entity.
Key points
Only authenticated and authorized user with an appropriate scope can update licenses.
The license can be updated for PRIMARY_CARE, EMERGENCY, OUTPATIENT, or PHARMACY legal entity.
The license can be updated for legal entities in ACTIVE or SUSPENDED statuses.
Only an additional license can be updated with this WS.
The additional license can be updated for legal entities with an active primary license.
Specification
| Page Properties | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Project Name | Електронний рецепт | COVID-certificate | |||||||||||||||||||||||||||||||||||||
Project abreviation | ePrescription | SVC | |||||||||||||||||||||||||||||||||||||
Developer | Edenlab | Розробник методу API. Наприклад, Edenlab | |||||||||||||||||||||||||||||||||||||
Project Manager | @Єлизавета Гессен-Дармштадська | ||||||||||||||||||||||||||||||||||||||
Tech Lead | @Іоанн Воїнов | ||||||||||||||||||||||||||||||||||||||
Product Owner | @Нікодім Святогорцев | ||||||||||||||||||||||||||||||||||||||
Вusiness analyst | Iryna Lishtaba (SoE eHealth) Oleksandr Zhuk (SoE eHealth) Oksana Demchenko | @Пантелеймон Нікомедійський | Status | ||||||||||||||||||||||||||||||||||||
| Status | |||||||||||||||||||||||||||||||||||||||
| colour | Green | title | APPROVED|||||||||||||||||||||||||||||||||||||
Version API paragraph not found 1.0 Date of release PROD Link Посилання на Apiary або Swagger Resource /api/licenses/{{id}} НаприкладПосилання на ресурс, наприклад: /api/persons/create Scope license:write Зазначається потрібний scopeScope для доступу Components ePrescriptionLegal Entities Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription Microservices API paragraph not found Перелік мікросервісів, які використовує метод API. Наприклад, наприклад: Auth, ABAC Protocol type REST Тип протоколу, який використовується запитом, наприклад: SOAP | REST Request type PATCH Тип HTTP методу, який використовується запитом, запиту API, наприклад: GET, POST | GET…, PATCH… Sync/Async Sync Метод є синхронним чи асинхронним? Public/Private/Internal Public |
Logic
Check if any attribute has changed comparing request and licenses table data (PRM DB). If any, then:
Update license data according to received request in licenses table (PRM DB)
Set updated_at = now()
Set updated_by = user_id.
Preconditions
Legal Entity exists and has Primary license.
...
No
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
id | String | Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
...
No
Request structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
...
Check that updated license exists in database
in case of error - return 404 (“License was not found”)
Check that updated license has
is_primary=falseflagin case of error - return 409 (“Only additional license can be updated”)
Check that additional license flag was passed in request ($.is_primary = false)
in case of error - return 422 (“Additional license can not be changed to primary”)
Check that updated license belongs to legal entity from access token
in case of error - return 409 (“License doesn't correspond to your legal entity")
Check that license type in request equals updated license type
in case of error - return 409 (“License type can not be updated”)
Check that legal entity has active primary license (request: select id from licenses where is_active=true and is_primary=true and legal_entity_id=$.legal_entity.id and (expiry_date >= current_date() or expiry_date is null); returns at least one value returns at least one value)
in case of error - return 404 (“No active primary license found for legal entity”)
...
Check that $.issued_date is not greater than $.active_from_date
in case of error - return 422 (“License can not be issued later than active from date”)
Check that $.active_from_date is not greater than $.expiry_date
in case of error - return 422 (“License can not have active from date later than expiration date”)
Check that $.expiry_date is not lesser than current_date
in case of error - return 409 (“License is expired”)
Parameters that are used when processing the request
Configuration parameters
Access to the method is defined by the scope license:write. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.
Dictionaries
...
Processing
API paragraph not found
Response structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
...