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

id	page_properties_method_REST API

Scope

Public/Private
Document type	Метод REST API
Document title	[Document status] REST API [Назва методу] [ID методу]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-001005-001009-001002-00010181
Microservices (namespace)	MPIIL
Component	AuthLegal Entities
Component ID	COM-001005-001009
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-details
Resource	{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package	legal_entities
Scope	legal_entity:read
Protocol type	REST
Request type	GET
Sync/Async	Sync

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

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

...

Private

Purpose

This service should be used for internal services/processes. Used without access_token

Logic

Image Added

Configuration parameters

Dictionaries

Input parameters

	Input parameter	Mandatory	Type	Description	Example
1	composition_id	M	String ($uuid) (path)	Composition object ID	89678f60-4cdc-4fe3-ae83-e8b3ebd35c59	Request	d290f1ee-6c54-4b01-90e6-d701748f0851
2

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

Expand

title	Example

Code Block

language	json

{
  "password": "qwerty"
}

Headers

...

Request data validation

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

Authorize

Used without access_token

If client knows the employee_request_ID he can create user and approve it.

Processing

Get Employee Request Details

Invoke WS Get Employee Request by ID for further employee creation

See service specification

Sample Request

Code Block
curl -X GET -H 'Content-Type: application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

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 API

Response structure examples

...

' 'http://ehealth.nebo15.com/employee_requests/d290f1ee-6c54-4b01-90e6-d701748f0851'

Search User

Search user in Auth using email from Employee_Request.

If found, goto Create user

else return Error 401

Create user in oAuth

System should create user in oAuth by using Create User WS

email should be used from the employee_request

password should be used from the payload

See service specification

Response structure examples

See on API-specification

Expand

title	Example

Code Block

language	json

{
  "meta": {
    "code": 201,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "email": "john@example.com",
    "settings": {},
    "priv_settings": {},
    "id": "user-1380df72-275a-11e7-93ae-92361f002671",
    "created_at": "2017-04-20T19:14:13Z",
    "updated_at": "2017-04-20T19:14:13Z"
  }
}

HTTP status codes

Only for active MPI record can be created medication request!

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		1000201	404 Response	Composition not found	COMPOSITION_NOT_FOUND_404	Не знайдено медичний висновок	3	401	Unauthorized	Помилка підтвердження
3		401		Search user error
4	Специфічні
5	422

Post-processing processes

Description of actions performed on data after processing

Technical

...

modules where the method is used

Page Properties Report

headings	ID ТМ, Статус
cql	label = "tr-mis"

...

Versions Compared

Old Version 2

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Authorize

Processing

Get Employee Request Details

Sample Request

Request data validation

Processing

Response structure examples

Create user in oAuth

Response structure examples

HTTP status codes

Post-processing processes

Technical

modules where the method is used

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Authorize

Processing

Get Employee Request Details

Sample Request

Request data validation

Processing

Response structure examples

Create user in oAuth

Response structure examples

HTTP status codes

Post-processing processes

Technical

modules where the method is used