Versions Compared

Old Version 2

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

[DRAFT] Get Employee Requests List [API-005-007-002-0113]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-001005-001007-001002-00010113

Microservices (namespace)

MPIIL

Component

AuthEmployees

Component ID

COM-001005-001007

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manageemployee-client-configurationrequests/get-employee-clientrequests-detailslist

Resource

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

Scope

employee_request:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

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

...

This WS is designed to search requests to registration employees by legal_entity_id and other filters

Logic

  1. Verify the validity of access token

  2. Check user scopes in order to perform this action

  3. If according to filters requests are not found, WS returns empty data array.

WS returns list of request objects include id and status, pagination data - for technical info.

Configuration parameters

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
Headers
...
Headers 
...
Request data validation
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
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
...
Authorize
Request to process the request using a token in the headers
Processing
Service returns specified Employee requests:
  1. Get Employee requests by ID from il.employee_requests
    1. Filter by search params
  2. Validate data consistency:
    1. Ensure that requested Employee requests relates to the legal entity from token:
      1. Return 403 ('Access denied') in case of error
  3. Render a response according to specification with found Employee requests:
    1. if according to filters requests are not found, WS returns empty data array
Response structure examples
See on API-specification 
 Expand
titleExample
 Code Block
languagejson
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "status": "NEW",
      "inserted_at": "2018-03-02T10:45:16.000Z",
      "edrpou": "5432345432",
      "legal_entity_name": "Клініка Ноунейм",
      "no_tax_id": true,
      "first_name": "Петро",
      "last_name": "Іванов",
      "second_name": "Миколайович"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}HTTP status codes
HTTP status codes
Специфічні
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
200
 Response
3
401
Unauthorized
Помилка підтвердження
4
Invalid access token
4
403
Access denied
5
422
Only for active MPI record can be created medication request!403
Your scope does not allow to access this resource. Missing allowances: employee_request:read
6
Специфічні
7
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"
...