Note
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties

id	page_properties_method_REST API

Document type	Метод REST API
Document title	[DRAFT] Deactivate equipment [API-007-002-002-0236]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-007-002-002-0236
Microservices (namespace)	ME
Component	Devices and equipment
Component ID	COM-007-002
Link на API-специфікацію
Resource	{{host}}/api/equipment/{{id}}/actions/deactivate
Scope	equipment:write
Protocol type	REST
Request type	PATCH
Sync/Async	Sync
Public/Private	Public

Purpose

N/A

Logic

Only authenticated and authorized HR, ADMIN, OWNER employees from MSP, OUTPATIENT, PRIMARY_CARE, EMERGENCY legal entities can deactivate equipments.
Only ACTIVE equipment can be deactivated
Legal entity can deactivate only its own equipments

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

id

String

Equipment identifier.

Required

d290f1ee-6c54-4b01-90e6-d701748f0851

Request structure

See on API-specification

Expand

title	Example

Code Block

Headers

Request data validation

Authorize

Verify the validity of access token
1. Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'equipment:write')
1. Return 403 in case invalid scope(s)

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)
1. In case of error - return 409 (Legal entity must be ACTIVE or SUSPENDED)

Validate equipment

Check that equipment with such ID exists in the system (is_active = true)
1. In case of error - return 404
Check that equipment belongs to the same legal entity as the user
1. In case of error - return 403

Validate transition

Only ACTIVE equipment can be deactivated

Available transitions

ACTIVE → INACTIVE

In other cases - return 409 error with message "INACTIVE equipment cannot be DEACTIVATED"

Processing

Update object in DB

1. equipments table

Patameter	Source	Description
status	Const: INACTIVE	By default INACTIVE for deactivated records
updated_at	Timestamp: now()	Get current date-time
updated_by	Token: user_id	Extract user from token

Save object to DB

1. equipment_status_hstr table

Parameter	Source	Description
id	UUID	Autogenerated
equipment_id	UUID	Reference to equipments.id
status	Const: INACTIVE	By default INACTIVE for deactivated records
inserted_by	Token: user_id	Extract user from token
inserted_at	Timestamp: now()	Get current date-time

Response structure examples

See on API-specification

Expand

title	Example

Code Block

language	json

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
    "division_id": "8be63914-a278-470b-b868-1af5b9087332",
    "legal_entity_id": "483af06f-d4c6-4c9e-8d9b-680b5ef7270d",
    "type": "23143534",
    "external_id": "123-ASD-#1",
    "udi": [
      {
        "value": "IMEI 49015420323751",
        "type": "default",
        "assigner_name": "Ukrainian center of the certification"
      }
    ],
    "lot_number": "RZ12345678",
    "manufacturer": "GlobalMed, Inc",
    "manufacture_date": "1999-01-01",
    "expiration_date": "2020-01-01",
    "model_number": "NSPX30",
    "part_number": "#e30-SD",
    "version": "v1.0.1",
    "name": "Рентген апарат флюрографічній",
    "serial_number": "S/N234554",
    "note": "Технічний огляд раз на рік",
    "status": "INACTIVE",
    "is_active": true,
    "inserted_at": "2017-04-20T19:14:13Z",
    "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
    "updated_at": "2017-04-20T19:14:13Z",
    "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name
1	Базові
2		200	Response
3		401		Access token validation failed
4		403		Invalid scope(s) Validation failed
5		404		Validation failed
6		409		Validation failed
7		409	INACTIVE equipment cannot be DEACTIVATED
8		409	Legal entity must be ACTIVE or SUSPENDED
9	Специфічні
10

Post-processing processes

N/A

Technical modules where the method is used

Page Properties Report

headings	ID ТМ, Статус
cql	label = "tr-mis"

Versions Compared

Old Version 1

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Authorize

Validate legal entity

Validate equipment

Validate transition

Processing

Update object in DB

1. equipments table

Save object to DB

1. equipment_status_hstr table

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Authorize

Validate legal entity

Validate equipment

Validate transition

Processing

Update object in DB

1. equipments table

Save object to DB

1. equipment_status_hstr table

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used