Versions Compared

Version Old Version 1 New Version Current
Changes made by

Mykhaylo Khapchyk (SoE eHealth)

Mykhaylo Khapchyk (SoE eHealth)

Saved on

Key

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

...

This WS is designed to return details of Device definition using its identifier.

Used to return device definition with the old structure only.

Will be deprecated

Specification

Page Properties
idAPI_Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/public.-devices/get-device-definition-details/get-device-definition-details

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

Resource

/api/device_definitions/id

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

Scope

device_definitions:read

Scope для доступу

Components

Public. Devices

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

Microservices

Devices

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

Protocol type

REST

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

Request type

GET

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

Sync/Async

Sync

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

Public/Private/Internal

Public

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

Filters

Filter

Values

Type

Description

Example

id

String

Device definition identifier

88ecde40-c97f-4b36-bffd-0da9c60d697c

...

  1. Get all device_definitions (PRM database) where device_definitions.classification_type is not empty.

  2. Get data from program_devices (PRM database) with following params:

    1. device_definition_id = id from URL

    2. is_active = true

    3. start_date <= current date()

    4. end_date >= current_date(), if not null

  3. Render a response according to specification

...

  • Check that device definition with such ID exists in the system

    • in case of error - return 404 ('Device definition is not found')

  • Check device_definitions.classification_type field is not empty.

    • in case of error - return 409 ('Use v2 route for this device definitionversion of API')

Headers

Content-Type:application/json

...