ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Purpose

This service returns client details

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

API paragraph not found

Request structure

API paragraph not found

Authorize

API paragraph not found

Headers

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

API-key:uXhEczJ56adsfh3Ri9SUkc4en

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

Example:

 Response example
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
    "name": "eHealth portal",
    "settings": {},
    "user_id": "user-1380df72-275a-11e7-93ae-92361f002671",
    "client_type_id": "261d52f9-b355-4029-863d-8fc52e9d0b81",
    "is_blocked": "false",
    "block_reason": "MSP has fakes doctors",
    "inserted_at": "2017-04-20T19:14:13Z",
    "updated_at": "2017-04-20T19:14:13Z",
    "client_type_name": "MSP"
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code

Message

What caused the error

200

 Response

 

403

authorization error if the requested client doesn't correspond with context

  • No labels

ЕСОЗ - публічна документація