ЕСОЗ - публічна документація
REST API Private. Get Medication Dispense by ID [API-005-008-001-0138]
- 1 Properties of a REST API method document
- 2 Purpose
- 3 Logic
- 4 Configuration parameters
- 5 Dictionaries
- 6 Input parameters
- 7 Filters
- 7.1 Query data
- 8 Request structure
- 9 Headers
- 10 Request data validation
- 11 Processing
- 12 Response structure examples
- 13 HTTP status codes
- 14 Post-processing processes
- 15 Technical modules where the method is used
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | REST API Private. Get Medication Dispense by ID [API-005-008-001-0138] |
Guideline ID | GUI-0011 |
Author | @Iryna Lishtaba (SoE eHealth) |
Document version | 1 |
Document status | PROD |
Date of creation | 24.02.2025 |
Date of update | 03.03.2025 |
Method API ID | API-005-008-001-0138 |
Microservices (namespace) | IL |
Link на API-специфікацію | |
Resource | {{host}}/api/admin/medication_dispenseses/id |
Scope | medication_dispense_admin:read |
Protocol type | REST |
Request type | GET |
Sync/Async | Sync |
Public/Private | Private |
Purpose
This method is designed to get Medication Dispense Details by NHS_ADMIN. In the response of these endpoint person_id is return in hashed form.
Logic
Verify the validity of access token
Return 401 in case validation fails
Check user scopes in order to perform this action (scope = 'medication_dispense_admin:read')
Return 403 in case invalid scope(s)
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | id | M | String | Medication dispense ID | a89f6a26-4221-4597-a1d2-542d5e40b565 |
Filters
Query data
Get certain record from medication_dispenses filtered by:
record should be active: is_active = true
id: Query param: id
Request structure
See on API-specification
Headers
Request data validation
N/A
Processing
N/A
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 |
|
|
|
|
|
| 3 |
|
|
|
|
|
| 4 | Специфічні | ||||
| 5 |
|
|
|
|
|
Post-processing processes
N/A
Technical modules where the method is used
Related content
ЕСОЗ - публічна документація