Versions Compared

Old Version 6

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
REST API method / Метод REST API (настанова) (
Info
Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

DEPRECATED [Document status] REST API [Назва методу] [ID методу]DRAFT] Get Global Parameters [API-004-001-001-0013]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-004-001-001-0013

Microservices (namespace)

Gitlab

Component

Configuration

Component ID

COM-004-001

Link на API-специфікацію

Resource

{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_packageglobal_parameters

Scope

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Private

Purpose

Update Return global parameters for declarations.

Logic

Method updates Methods returns global parameters for declarations.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input N/A

Dictionaries

N/A

Input parameters

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

Input parameter

Mandatory

Type

Description

Example

1

composition_id

 M

String ($uuid) (path)

Composition object ID

2

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Expand
titleExample
Code Block
{
  "declaration_term": "30",
  "declaration_request_expiration": "30",
  "employ_request_expiration": "30",
  "verification_request_expiration": "30",
  "adult_age": "18",
  "billing_date": "2"
}

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIHeaders

Request data validation

N/A

Processing

N/A

Response structure examples

Description of the REST API response structure, exampleSee on API-specification

Expand
titleExample
Code Block
languagejson
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "declaration_term": "30",
    "declaration_request_expiration": "30",
    "employ_request_expiration": "30",
    "verification_request_expiration": "30",
    "adult_age": "18",
    "billing_date": "2"
  }
}

HTTP status codes

401Only for active MPI record can be created medication request!

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

1000

404

Composition not found

COMPOSITION_NOT_FOUND_404

Не знайдено медичний висновок 200

3

Специфічні

Unauthorized

Помилка підтвердження

4

Специфічні

5

422

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical N/A

Technical modules where the method is used

Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"

...