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

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

« Previous Version 3 Next »

Purpose

This method allows finding all persons, which were merged with this person. Also, this endpoint shows all the persons who enter the whole chain of merges to this person.

Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/persons/search-person%27s-merged-persons

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

Resource

/api/persons/{{id}}/merged_persons

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

Scope

person:read

Scope для доступу

Components

Patient registry

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

Microservices

mpi/api

il/api (rpc)

fe/admin-web

Перелік мікросервісів, які використовує метод 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

Input parameters

See on Apiary

Filters

See on Apiary

Dictionaries

GENDER https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1321533446/PHONE+TYPE

Authorize

Request to process the request using a token in the headers

Headers

Наприклад:

Content-Type:application/json

Authorization:Bearer {{access_token}}

api-key: {{secret}}

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

Example:

 Response example. Code: 200
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "57e30ea3-16f1-4f8e-adcd-1a05e99e2d22",
      "inserted_at": "2019-05-08T15:34:00Z",
      "merge_person_id": "bdadc2a7-7283-4f24-bc99-8d8d9808af80",
      "master_person_id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "updated_at": "2019-05-08T15:34:00Z"
    },
    {
      "id": "a4181621-681f-4e46-b0ba-7fa4e59859ef",
      "inserted_at": "2019-01-08T15:34:00Z",
      "merge_person_id": "1a356e56-a991-4ceb-a475-3edfd9930265",
      "master_person_id": "bdadc2a7-7283-4f24-bc99-8d8d9808af80",
      "updated_at": "2019-01-08T15:34:00Z"
    }
  ]
}
 Response example. Code: 404
{
  "meta": {
    "code": 404,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "error": {
    "type": "forbidden",
    "message": "Such person not found"
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code

Message

What caused the error

 200

 Response

 

 404

 Such person not found

 

  • No labels