Versions Compared

Old Version 1

changes.mady.by.user Mykhailo Troinin (SoE eHealth)

Saved on

compared with

New Version 2

changes.mady.by.user Mykhailo Troinin (SoE eHealth)

Saved on

Key

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

Document properties

Page Properties

Parameter

Value

Description

Document status

Status
colourBlue
titleDRAFT

Поточний статус документу

Decision maker

Особа що приймає рішення

Decision

    Прийняте рішення

    Purpose

    Specification

    Page Properties

    Parameter

    Value

    Description

    Method ID

    Унікальний ідентифікатор методу

    Microservices

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

    Components

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

    Essence

    Назва сутності до якої належить метод

    Link

    https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-details

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

    Resource

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

    Scope

    Scope для доступу

    Protocol type

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

    Request type

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

    Sync/Async

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

    Public/Private/Internal

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

    Logic

    Request structure

    Expand
    titleRequest example
    Code Block
    Insert request code

    Authorize

    Headers

    Request data validation

    Processing

    Response structure

    Example:

    Expand
    titleResponse example. Code: 200
    Code Block
    Insert answer code
    Expand
    titleResponse example. Code: 403
    Code Block
    Insert answer code

    Post-processing processes

    HTTP status codes

    Error code

    HTTP status code

    Message

    Translation of the message

     

     

     

    Recommended attribute translations

    Attribute Name

    Sub Attribute Name

    Attribute Type

    Переклад (рекомендований)

    Реалізація МІС XX.XX обов'язкова

    Заповнює користувач

    Відтворення в UI

    Метод API

    Методи API

    Technical modules where the method is used

    Page Properties Report