...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Table of Contents |
|---|
Purpose
Specification
Apiary: Update equipment
...
| Table of Contents |
|---|
Purpose
This method used for update equipment data, except link with division and status
Specification
| Page Properties | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
|
Logic
Only authenticated and authorized HR, ADMIN, OWNER employees can update equipment.
Equipment can be updated from MSP, OUTPATIENT, PRIMARY_CARE and EMERGENCY legal entities.
Only ACTIVE equipment can be updated.
Update of division_id and status is not allowed with this service.
Legal entity can update only its own equipments.
...
Input parameters
Input parameter | Values | Type | Description | Example |
|---|---|---|---|---|
id | String | Equipment identifier. Required | d290f1ee-6c54-4b01-90e6-d701748f0851 |
Request structure
Example:
| Expand | ||
|---|---|---|
| ||
|
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check user scopes in order to perform this action (scope = 'equipment:write')
Return 403 in case invalid scope(s)
Headers
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en
Request data validation
Validate legal entity
Check that legal entity is active (status = ACTIVE, SUSPENDED)
...
Extract client_id
...
from token (token.client_id == legal_entity_id)
Check legal entity status (status = ACTIVE, SUSPENDED)
In case of error - return 409 (Legal entity must be ACTIVE or SUSPENDED)
Validate equipment
Check that ID in URL exists in the system
In case of error - return 404
Check that equipment belongs to the same legal entity as the user
In case of error - return 403
Validate request
Validate request using schema
Processing
Update object in DB
1.
...
equipment table
Parameter | Source | Description |
|---|---|---|
type | Request: type | Get from request body |
external_id | Request: external_id | Get from request body |
udi | Request: udi | Get from request body |
lot_number | Request: lot_number | Get from request body |
manufacturer | Request: manufacturer | Get from request body |
manufacture_date | Request: manufacture_date | Get from request body |
expiration_date | Request: expiration_date | Get from request body |
model_number | Request: model_number | Get from request body |
part_number | Request: part_number | Get from request body |
version | Request: version | Get from request body |
name | Request: name | Get from request body |
serial_number | Request: serial_number | Get from request body |
note | Request: note | Get from request body |
updated_at | Timestamp: now() | Get current date-time |
updated_by | Token: |
user_id | Extract user from token |
Response structure
Example:
| Expand | ||
|---|---|---|
| ||
|
HTTP status codes
| Page Properties | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|