1 Properties of a REST API method document
2 Purpose
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Authorize
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
14 Technical modules where the method is used

Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] REST API Search Person's merged persons [API-010-001-003-0361]
Guideline ID	GUI-0011
Author	@Yuliia Mazur (UA SoE eHealth)
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-010-001-003-0361
Microservices (namespace)	MPI, IL, ADMIN-FE
Component	Person
Component ID	COM-010-001
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/persons/search-person%27s-merged-persons
Resource	{{host}}api.ehealth.gov.ua/api/persons/id/merged_persons
Scope	person:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

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.

Logic

N/A

Configuration parameters

N/A

Dictionaries

GENDER
PHONE_TYPE

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1	id	M	String		Example: `b075f148-7f93-4fc2-b2ec-2d81b19a9b7b`
2	status	O	String		Example: `MERGED`

Request structure

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

Headers

Key	Value	Mandatory (M/O)	Description	Example

Key	Value	Mandatory (M/O)	Description	Example
Content-Type	application/json	M	Вказує формат даних у тілі запиту/відповіді	Content-Type: application/json
Authorization	Bearer {{access_token}}	M	Вказує токен авторизації для доступу	Authorization: Bearer Token
Api-key	{{secret}}	M		uXhEczJ56adsfh3Ri9SUkc4en
X-Custom-PSK	{{pre_shared_key}}	M	Попередньо узгоджений ключ для аутентифікації	X-Custom-PSK

Request data validation

Authorize

Request to process the request using a token in the headers

Processing

N/A

Response structure examples

Example:

{
  "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"
    }
  ]
}

{
  "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"
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200	Response		Надано відповідь
3		404	Such person not found		Особа не знайдена
4	Специфічні
5

Post-processing processes

N/A

Technical modules where the method is used

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

REST API Search Person's merged persons [API-010-001-003-0361]

Analytics