...
...
...
...
| Table of Contents |
|---|
...
Purpose
This WS is designed to deactivate medication by ID (post).
APIary
Input parameters
...
| Table of Contents | ||||
|---|---|---|---|---|
|
Purpose
This WS is designed to deactivate brand by ID (post)
Specification
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Logic
This method is used to deactivate INNM Dosage. 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
...
scope (scope = '
...
innm_dosage:
...
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: "
...
Innm_dosage is not found!")
Validate status
Purpose validation: Medication should be active (is_active == TRUE)
Validate `is_
...
primary` == TRUE
if invalid - return 409 error (message: "Innm_dosage should be active !")
Validate type
Purpose validation: Medication should be type = INNM_DOSAGE
Validate `type` == INNM_DOSAGE
if invalid - return 409 eror (message: "
...
Medication must be type = INNM_DOSAGE !")
Validate status linked Medications
Purpose validation: For INNM Dosage - all linked (child) Medications should be inactive (is_active primary == FALSE)
Get linked medications, check exist active medications
if invalid - return 409 eror (message: "All linked medication should be inactive !")
...
| language | sql |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
Processing
Update medication
Update medication record by $.id set values:
Destination | Source |
is_active | FALSE |
...
updated_at | :timestamp |
...
updated_by | user_id |
...
Prepare & return response data structure
...
...
Response structure
See on Apiary
Example:
| Expand | ||
|---|---|---|
| ||
|
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes
API paragraph not found
HTTP status codes
| Page Properties | |||||||||
|---|---|---|---|---|---|---|---|---|---|
|