Table of Contents |
---|
Purpose
This WS allows to get Specimen without patient context by its accession identifier.
Specification
Link | |
Resource | /api/specimens/accession_identifier |
Scope | specimen:read |
Components | Specimen |
Microservices |
|
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private/Internal | Public |
...
Filter | Values | Type | Description | Example |
---|---|---|---|---|
accession_identifier |
| String | human readable Specimen number | 1234-3224-2342-1233 |
Request structure
See on Apiary
Authorization
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
Headers
Content-Type:application/json
Authorization:Bearer mF_9.B5f-4.1JqM
api-key:aFBLVTZ6Z2dON1V
X-Custom-PSK:a2aa05c76f3f2d91870f923a53cc8aa8f23bbc01a8238d1c2c26d4299715a7e4
Response structure
See on Apiary
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 |
|
|
401 | Invalid access token |
|
403 | Your scope does not allow to access this resource. Missing allowances: specimen:read |
|
404 | Specimen is not found |