Properties of a REST API method document

Purpose

N/A

Logic

1. Only authenticated and authorized HR, ADMIN, OWNER employees from MSP, OUTPATIENT, PRIMARY_CARE, EMERGENCY legal entities can activate equipments

2. Only INACTIVE equipment can be activated

3. Legal entity can activate only its own equipments

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorize

1. Verify the validity of access token

   1. Return 401 in case validation fails

2. Check scopes in order to perform this action (scope = 'equipment:write')

   1. Return 403 in case invalid scope(s)

Check that legal entity is active (status = ACTIVE, SUSPENDED)

1. Extract client_id from token (token.client_id == legal_entity_id)

2. Check legal entity status (status = ACTIVE, SUSPENDED)

   1. In case of error - return 409 (Legal entity must be ACTIVE or SUSPENDED)

Validate division

Check that division is active

1. Check division status (status = ACTIVE)

   1. In case of error - return 409 (Division must be active)

Validate equipment

1. Check that equipment with such ID exists in the system (is_active = true)

   1. In case of error - return 404

2. Check that equipment belongs to the same legal entity as the user

   1. In case of error - return 403

Validate transition

Only INACTIVE equipment can be activated

Available transitions

1. INACTIVE → ACTIVE

In other cases - return 409 error with message "ACTIVE equipment cannot be ACTIVATED"

Processing

Update object in DB

1. equipments table

Save object to DB

1. equipment_status_hstr table

Response structure examples

See on API-specification

{
  "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": "ACTIVE",
    "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

Post-processing processes

N/A

Technical modules where the method is used