Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Page Properties
idAPI_Specification

Link

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

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

Resource

/api/equipment

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

Scope

equipment:write

Scope для доступу

Components

Equipment

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

Microservices

API paragraph not found

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

Protocol type

REST

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

Request type

POST

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

Sync/Async

Sync

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

Public/Private/Internal

Public

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

Logic

  1. Only authenticated and authorized HR, ADMIN, OWNER employees can register equipments.

  2. Equipments can be registered in MSP, OUTPATIENT, PRIMARY_CARE and EMERGENCY legal entities.

  3. Equipment has to be linked to division. One division can have many equipments.

  4. Legal entity can register equipments for its own divisions only.

...

  1. Verify the validity of access token

    1. Return 401 in case validation fails

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

    1. Return 403 in case invalid scope(s)

Headers

Наприклад:

Content-Type:application/json

...

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

 201201

 Response

 

401

Access token validation failed

403

Invalid scope(s)

409

Validation failed

422

Validation failed