...
...
...
...
...
...
...
...
| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
| Table of Contents | ||
|---|---|---|
|
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 | Async |
Public/Private | Public |
Purpose
This WS allows to get Specimen without patient context by its 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
...