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/manage-client-configuration/get-client-details

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

Resource

/api/clients/{{id}}

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

Scope

client:read

Scope для доступу

Components

Manage client configuration

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: 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

  1. Extract client_type from token

  2. Validate specified ID according to context:

    1. Mithril Admin - receives all client records

    2. MSP, MIS, PHARMACY - receives only its own client

      1. in case of error generate 403 response ('forbidden')

...

Page Properties
idAPI_HTTP status codes

HTTP status code

Message

What caused the error

200

 Response

 

401

Access denied

403

  • Invalid scopes

  • Forbidden