Versions Compared

Key

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

Table of Contents
Status

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 Substance detail.

APIary

get-substance-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 = 'substance:read')

Validate PK Medication

Purpose validation: Check on existing Substance record 

  1. Check exist Substance by $.id.

    1. if invalid - return 404 error (message: "Substance is not found!")

Validate status

Purpose validation:  Substance should be active (is_active == TRUE)

  1. Validate `is_active` == TRUE
    1. if invalid  - return 409 eror (message: "Substance is not 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)