Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties


Specification

Status
colourRedGreen
titlespecsdone

Apiary

Status
colourRedGreen
titlespecsdone

JSON Schema request

Status
colourRedGrey
titlespecsabsent

JSON Schema response
Status
colourRed
titlespecs


Purpose

This WS is dedesigned to return Medications list by filters.

APIary

get-medications-list

Input parameters (filters)

  • id (optional)
  • innm_id (optional)
  • name (optional, as `LIKE *`)
  • innm_name (optional, as `LIKE *`)
  • form (optional)

Logic WS

  1. Verify the validity of access token
  2. Check user scopes in order to perform this action (scope = 'medication:read')
  3. Search Medications by filters in payload

    Code Block
    languagesql
    SELECT * FROM medications MED
    	LEFT JOIN medications INNM
    		ON MED.ingredients.id = INNM.id 
    			AND INNM.is_active == TRUE
    WHERE MED.is_active == TRUE
    	AND MED.type == MEDICATION
    	AND (MED.id == $.id OR $.id IS NULL)
    	AND (INNM.id == $.innm_id OR $.innm_id IS NULL)
    	AND (MED.form == $.form OR $.form IS NULL)
    	AND (MED.name LIKE `%$.name%` OR $.name IS NULL)
    	AND (INNM.name LIKE `%$.innm_name%` OR $.innm_name IS NULL)
    
    


Prepare & return response data structure

  1. Fill response WS data structure 
  2. Validate response using JSON schemas (!!! TBD)
    1. Return 422 with list of validation errors in case validation fails (422 EView)