...
This WS allows to get a single Specimen by its identifier.
Specification
Link | |
Resource | api/patients/patient_id/specimens |
Scope | specimen:read |
Components | Specimen |
Microservices | ABAC |
Protocol type | REST |
Request type | GET |
Sync/Async | Async |
Public/Private/Internal | Public |
...
Filter | Values | Type | Description | Example |
|---|---|---|---|---|
patient_id |
| String | Unique patient identifier | 7075e0e2-6b57-47fd-aff7-324806efa7e5 |
id |
| String | Unique specimen identifier | 7075e0e2-6b57-47fd-aff7-324806efa7e5 |
Request structure
See on Apiary
Authorization
Verify the validity of access token
in case of error - 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 and client 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)
Access to the resource is also managed by ABAC module
...
Get Specimen identifier from the URL
Check it exists in DB
Return 404 ('not found') in case of error
Check Specimen belongs to patient
Return 404 ('not found') in case of error
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 | not found |