Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Table of Contents

...

Specification

...

...

Apiary
JSON Schema response
Status
colourRed
titlespecs

Purpose

This WS is designed to deactivate medication by ID (post).

APIary 

deactivate-medication


Input parameters 

  • id

Authorize

  1. Verify the validity of access token
  2. Check user scope (scope = 'medication:write') in order to perform this action
    1. In case error - generate 401 response

...

  1. Check exist Medication by $.id.

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

...

    1. if invalid  - return 409 eror (message: "Medication should be active !")

Update medication

Update medication record by $.id  set values:


Destination
Source
is_active FALSE
inserted_at:timestamp
inserted_byuser_id
updated_at:timestamp
updated_byuser_id

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)