...
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.
...
Response code | HTTP Status code | Message | Internal name | Description | |
|---|---|---|---|---|---|
| 1 | Базові | ||||
| 2 | 401 | Invalid access token |
| Недійсний Недійсний токен доступу | |
| 3 | 403 | Your scope does not allow to access this resource. Missing allowances: specimen:read |
| Відсутня можливість доступу до цього ресурсу через брак наявності скоупу: specimen:read | |
| 4 | 404 | Specimen is not found | Зразок не знайдено | ||
...