| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose*
Returns declaration requests that were created through V2 and V3.
Specification*
...
Link
...
...
Resource
...
/api/v3/declaration_requests/{id}
...
Scope
...
declaration_request:read
...
Components
...
<Необхідно зазначити перелік компонентів, які використовують цей метод, наприклад: ePrescription>
...
Global and configure parameters
...
<Потрібно вказати глобальні та конфігураційні параметри>
...
Using Dictionaries
...
<Потрібно вказати словники, які використовує метод API>
...
Using Microservices
...
<Вкажіть перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC>
...
Protocol type
...
REST API
...
Request type
...
GET
...
Sync/Async
...
<Метод є синхронним чи асинхронним?>
Logic*
Fields person_id and data_to_be_signed will be empty if declaration request is created by V2.
Only authenticated and authorized user can use declaration request
The service returns only a declaration request that was created in the same legal entity as the user
Input parameters
...
Filter
...
Values
...
Type
...
Description
...
Example
...
id
...
...
String
...
request identifier
...
d290f1ee-6c54-4b01-90e6-d701748f0851
Request structure*
See on Apiary
Authorize*
Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'declaration_request:read')
Return 403 in case invalid scope(s)
Request to process the request using a token in the headers.
Headers*
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validate request (JSON schema)*
<Наприклад:
Validate request using JSON schema
In case validation failed - generate 422 error
| Expand | ||
|---|---|---|
| ||
|
Validation data request*
<Валідація даних>
Processing*
1. Using global parameters
<Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри>
2. Generate structure for response
<Наприклад:
Collect response array for all programs in payload with status for each (VALID or INVALID) and rejection_reason
For all VALID programs - Get linked medications (type = BRAND) with reimbursement info
Show only active program medications based on start_date and end (start_date must be earlier or equal to the current date or empty, end_date must be greater or equal to the current date or empty)
...
| Code Block |
|---|
IF EXISTS
(SELECT * FROM program_medications MP
INNER JOIN medications M
ON M.id = MP.medication_id
AND M.type = BRANDS
INNER JOIN ingredients I
ON I.parend_id = M.id
AND I.is_primary = TRUE
AND I.medication_child_id = _MR.medication_id
WHERE MP.medical_program_id == $.id
AND MP.is_active == TRUE
AND M.is_active == TRUE)
|
>
| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose
Returns declaration requests that were created through V2 and V3
Key features
Fields person_id and data_to_be_signed will be empty if declaration request is created by V2.
Only authenticated and authorized user can use declaration request
The service returns only a declaration request that was created in the same legal entity as the user
Specification
Link | |
Resource | /api/v3/declaration_requests/{{id}} |
Scope | declaration_request:read |
Components | Declarations |
Using Dictionaries | API paragraph not found |
Using Microservices | API paragraph not found |
Protocol type | REST |
Request type | GET |
Sync/Async | API paragraph not found |
Public/Private/Internal | Public |
Logic
API paragraph not found
Input parameters
Filter | Values | Type | Description | Example |
|---|---|---|---|---|
id |
| String | request identifier |
|
Request structure
API paragraph not found
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'declaration_request:read')
Return 403 in case invalid scope(s)
Request to process the request using a token in the headers.
Headers
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Validation data request
API paragraph not found
Processing
API paragraph not found
Response structure*
Print form is generated after approve declaration request, so in response on Get decl request by id show fields contextand data_to_be_signed if DR approved.
...
Post-processing processes*
<Що має відбутися в ЦБД після опрацювання запиту>
HTTP status codes
HTTP status code | Message | What caused the error |
|---|---|---|
200 |
|
|
...