Table of Contents |
---|
Page Properties | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Purpose
This WS is dedesigned to return Substance detail.
APIary
Input parameters (filters)
- id
Logic WS
- Verify the validity of access token
- Check user scopes in order to perform this action (scope = 'substance:read')
Validate PK Medication
Purpose validation: Check on existing Substance record
Check exist Substance by $.id.
if invalid - return 404 error (message: "Substance is not found!")
Validate status
Purpose validation: Substance should be active (is_active == TRUE)
- Validate `is_active` == TRUE
- if invalid - return 409 eror (message: "Substance is not active !")
Prepare & return response data structure
- Fill response WS data structure
- Validate response using JSON schemas (!!! TBD)
- Return 422 with list of validation errors in case validation fails (422 EView)