Table of Contents |
---|
Purpose
This WS is designed to return a list of detailed information for all active medications (with type innm_dosage) by search parameters.
Specification
Page Properties | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Project Name | Електронний рецепт | COVID-certificate | ||||||||||||||||||||||||||
Project abreviation | ePrescription | SVC | ||||||||||||||||||||||||||
Developer | API paragraph not found | Розробник методу API. Наприклад, Edenlab | ||||||||||||||||||||||||||
Project Manager | API paragraph not found | @Єлизавета Гессен-Дармштадська | ||||||||||||||||||||||||||
Tech Lead | API paragraph not found | @Іоанн Воїнов | ||||||||||||||||||||||||||
Product Owner | API paragraph not found | @Нікодім Святогорцев | ||||||||||||||||||||||||||
Вusiness analyst | API paragraph not found | @Пантелеймон Нікомедійський | Status |
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Version
API paragraph not found
1.0
Date of release
Link | https://uaehealthapiehealthmisapi1.docs.apiary.io/#reference/public.-reimbursement/drugs/get-drugs-list-v2 | Посилання на Apiary або Swagger | |
Resource | /api/v2/drugs | НаприкладПосилання на ресурс, наприклад: /api/persons/create | |
Scope | drugs:read | Зазначається потрібний scopeScope для доступу | |
Components | ePrescription, ReimbursementDrugs and Program medications | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | |
Microservices | API paragraph not found | Перелік мікросервісів, які використовує метод API. Наприклад, наприклад: Auth, ABAC | |
Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | |
Request type | GET | Тип HTTP методу, який використовується запитомзапиту API, наприклад: GET, POST | GET…, PATCH… | |
Sync/Async | Sync | Метод є синхронним чи асинхронним? | |
Public/Private/Internal | Public |
Logic
Service returns all medications (with type innm_dosage) filtered by submitted parameters:
1. Get all medications (PRM database):
Expand | ||
---|---|---|
|
2. Filter list above by submitted search parameters.
3. Render a response according to specification with found medications entities.
Preconditions
No
Global and configurable parameters
No
Input parameters
No
Filters
See on Apiary
Request structure
API paragraph not found
Authorize
Verify the validity of access token
Return (401, 'Invalid access token') in case of validation fails
Verify that token is not expired
in case of error - return (401, 'Invalid access token')
Check user scopes in order to perform this action (scope = 'drugs:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: drugs:read') in case of invalid scope(s)
...
API-key:uXhEczJ56adsfh3Ri9SUkc4en
Validate request
API paragraph not found
Request data validation
API paragraph not found
Parameters that are used when processing the request
Configuration parameters
Access to the method is defined by the scope drugs:read. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.
Dictionaries
API paragraph not found
Processing
API paragraph not found
Response structure
See on Apiary
Example:
Expand | ||
---|---|---|
| ||
|
Post-processing processes
No
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 | Response |
|
401 | Invalid access token |
|
403 | Your scope does not allow to access this resource. Missing allowances: drugs:read | Invalid scope |
Backward compatibility
...