Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Purpose

API paragraph not found

...

Page Properties
idAPI_Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/equipment/activate-equipment

Посилання на Apiary або Swagger

Resource

/api/equipment/{{id}}/actions/activate

Посилання на ресурс, наприклад: /api/persons/create

Scope

equipment:write

Scope для доступу

Components

EquipmentDevices and equipment

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

PATCH

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Public

Потрібно зазначити тип методу за ступенем доступності

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

...

  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)

Headers

Наприклад:

Content-Type:application/json

...

Processing

Update object in DB

1. equipments table

Patameter

Source

Description

status

Const: ACTIVE

By default ACTIVE for activated 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: ACTIVE

By default ACTIVE for activated records

inserted_by

Token: user_id

Extract user from token

inserted_at

Timestamp: now()

Get current date-time

...

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

200

 Response

 

401

 

Access token validation failed

403

 

  • Invalid scope(s)

  • Validation failed

404

Validation failed

409

Validation failed

Purpose

Specification

Apiary: Activate equipment

Service logic

Authentication

Validate legal entity

Update object in DB

1. equipments table

...

Patameter

...

Source

...

Description

...

status

...

Const: ACTIVE

...

By default ACTIVE for activated 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: ACTIVE

...

By default ACTIVE for activated records

...

inserted_by

...

Token: user_id

...

Extract user from token

...

inserted_at

...

Timestamp: now()

...