...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Table of Contents |
|---|
...
...
Purpose
This WS is designed to deactivate medication by ID (post).
Input parameters
- id
...
| Table of Contents | ||||
|---|---|---|---|---|
|
Required parameters are marked with "*"
Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.
Purpose*
This WS is designed to deactivate medication by ID (post).
Specification*
| Page Properties | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic*
This method is used to deactivate Medication. Fields descriptions are listed in request Example view.
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
id | String |
|
Request structure*
API paragraph not found
Authorize*
Verify the validity of access token
Check user
scopescope (scope = 'medication:deactivate') in order to perform this action
In case error - generate 401 response
Request to process the request using a token in the headers
Headers*
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
Request data validation*
Validate PK Medication
Purpose validation: Check on existing Medication record
Check exist Medication by $.id.
if invalid - return 404 error (message: "Medication is not found!")
...
Purpose validation: Medication should be active (is_active == TRUE)
Validate `is_active` == TRUE
if invalid - return 409 eror (message: "Medication should be active !")
Validate type
Purpose validation: Medication should be type = BRAND
Validate `type` == BRAND
if invalid - return 409 eror (message: "Medication must be type = BRAND !")
Processing*
Update medication
Update medication record by $.id set values:
Destination | Source |
is_active | FALSE |
updated_at | :timestamp |
updated_by | user_id |
Response structure*
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes*
API paragraph not found
HTTP status codes*
| Page Properties | |||||||||
|---|---|---|---|---|---|---|---|---|---|
|