Versions Compared

Key

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

...

Page Properties

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/person-requests/get-person-request-by-id

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

Resource

/api/person_requests/{{id}}

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

Scope

person_request:read

Scope для доступу

Components

Patient registry

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

Microservices

il/api

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

Input parameters

Input parameter

Values

Type

Description

Example

id

String

Request identifier. Required

eeebb86d-5cba-43c9-885b-6482ecaf826b

Dictionaries

  • GENDER

  • DOCUMENT_TYPE

  • ADDRESS_TYPE

  • COUNTRY

  • SETTLEMENT_TYPE

  • STREET_TYPE

  • PHONE_TYPE

  • AUTHENTICATION_METHOD

  • CONFIDANT_PERSON_TYPE

  • PREFERRED_WAY_COMMUNICATION

  • DOCUMENT_RELATIONSHIP_TYPE

Request structure

See on Apiary

Authorize

  1. Verify the validity of access token

    1. Return 401 in case validation fails

  2. Check scopes in order to perform this action (scope = 'person_request:read')

    1. Return 403 in case invalid scope(s)

...

Authorization:Bearer {{access_token}}

api-key::{{secret}}

Request data validation

API paragraph not found

...

API paragraph not found

Response structure

Example:

...

Page Properties

HTTP status code

Message

What caused the error

200

Response

 

401

 Validation Validation failed

403

Invalid scope