Versions Compared

Key

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

...

This method is designed to retrieve eHealth dictionaries

Specification

Page Properties
idAPI_Specification

Link

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

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

Resource

/api/dictionaries

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

Scope

dictionary:read

Scope для доступу

Components

Dictionaries

...

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

Microservices

API paragraph not found

...

Using Microservices

...

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

Protocol type

REST

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

Request type

GET

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

Sync/Async

Sync

Logic

API paragraph not found

Preconditions

API paragraph not found

...

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

Public/Private/Internal

Public

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

Logic

API paragraph not found

Input parameters

NoneNo

Filters

NoneNo

Authorize

API paragraph not found

Headers

Example

Expand
titleHeader example
Code Block
Content-Type: application/json

Validate request (JSON schema)

API paragraph not found

Validation data request

API paragraph not found

...

API paragraph not found

Response structure

See on Apiary

Example:

Expand
titleResponse example
Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "name": "DOCUMENT_TYPE",
      "values": {
        "key": "value"
      },
      "labels": [
        "SYSTEM",
        "EXTERNAL"
      ],
      "is_active": true
    }
  ]
}

...

HTTP status code

Message

What caused the error

200

Response

 

Backward compatibility

API paragraph not found

...