Versions Compared

Key

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

Status


Specification

DONE

Apiary

DONE

JSON Schema request

ABSENT

JSON Schema response
SPECS


Purpose

This WS is designed to return Program_medications detail.

APIary

Get Program medications by id                                               

Input parameters (filters)

  • id 

Logic WS

  1. Verify the validity of access token
  2. Check user scopes in order to perform this action (scope = 'program_medications:read')

Validate PK Medication

Purpose validation: Check on existing record for the participant (Medication within the Medical program)

  1. Check exist  participant "Program_medications" by $.id

    1. if invalid - return 404 error (message: "ID for Medication linked with the Medical program is not found!")

Validate status

Purpose validation:  Participant (medication within the program) should be active (is_active == TRUE) 

  1. Validate `is_active` == TRUE
    1. if invalid  - return 409 eror (message: "Participant should be active!")

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)