| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
...
Properties of a REST API method document
Document type | Метод REST API |
|---|---|
Document title | [DRAFT] REST API Get Specimen by accession identifier [API-007-012-001-0496] |
Guideline ID | GUI-0011 |
Author | @ |
Document version | 1 |
Document status | DRAFT |
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
Method API ID | API-007-012-001-0496 |
Microservices (namespace) | ME |
Component | Specimen |
Component ID | COM-007-012 |
Link на API-специфікацію | |
Resource | {{host}}/api/specimens/accession_identifier |
Scope | specimen:read |
Protocol type | REST |
Request type | GET |
Sync/Async |
Sync | |
Public/Private | Public |
|---|
Purpose
This WS allows to get Specimen without patient context by its accession identifier.
...
Returns a single Specimen that has a specified accession_identifier
ABAC isn’t used here
Logic
https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/17629118915/RC.#%D0%9E%D1%82%D1%80%D0%B8%D0%BC%D0%B0%D0%BD%D0%BD%D1%8F-%D1%96%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D1%96%D1%97-%D0%97%D1%80%D0%B0%D0%B7%D0%BA%D0%B0-%D0%B1%D0%B5%D0%B7-%D0%B2%D0%B7%D0%B0%D1%94%D0%BC%D0%BE%D0%B4%D1%96%D1%97-%D0%B7-%D0%BF%D0%B0%D1%86%D1%96%D1%94%D0%BD%D1%82%D0%BE%D0%BC[DRAFT] BP-ESOZ-028-0004 [MIS] Отримання інформації Зразка без взаємодії з пацієнтом
Service returns a single Specimen that has a specified accession_identifier:
...
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 = 'specimen:read')
Return (403, 'Your scope does not allow to access this resource. Missing allowances: specimen:read') in case of invalid scope(s)
Validate Specimen
Get Specimen identifier from the URL
Check it exists in DB
Return 404 ('Specimen is not found.') in case of error
Processing
N/A
Response structure examples
...
Response code | HTTP Status code | Message | Internal name | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Базові | |||||||||
| 2 | 200 |
|
| 3 | 401 | Invalid access token |
| Недійсний токен доступу | ||
| 43 | 403 | Your scope does not allow to access this resource. Missing allowances: specimen:read |
| 5Відсутня можливість доступу до цього ресурсу через брак наявності скоупу: specimen:read | ||||||
| 4 | 404 | Specimen is not found | Зразок не знайдено | |||||||
Post-processing processes
...
Technical modules where the method is used
N/A