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/updateget-equipment-list

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

Resource

/api/equipment

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

Scope

equipment:read

Scope для доступу

Components

EquipmentDevices and equipment

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

Microservices

API paragraph not found

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

Protocol type

REST

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

Request type

GET

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

Sync/Async

Sync

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

Public/Private/Internal

Public

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

Logic

API paragraph not found

Filters

See on Apiary

Request structure

API paragraph not found

...

API paragraph not found

Headers

Наприклад:

Content-Type:application/json

...

API paragraph not found

Response structure

...

Example:

Expand
titleResponse example
Code Block
{
  "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"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

...