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

[DRAFT] Get Declarations List [API-005-004-001-0059]

Owned by Kateryna Yakovleva
Last updated: Nov 25, 2024 by Anastasiia Prokhorova (SoE eHealth)
3 min read

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

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

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-005-004-001-0059

Microservices (namespace)

IL

Component

Declarations

Component ID

[MIS] Отримання даних декларації

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declarations/get-declarations-list

Resource

{{host}}/api/declarations

Scope

declaration:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This WS is designed to obtain a declaration list. 

Key points

  1. This is a REST method used by MIS.

  2. Only authenticated and authorized employee with appropriate scope can get declarations list.

  3. Method returns shortened declaration details, to obtain full information - use Get Declaration by ID method.

Logic

  1. Filter declarations by search params.

  2. Render found declarations with shortened details according to specification.

Use this method to obtain a list of Declarations for an employee_id and legal_entity_id. If you want to reduce the amount of data that is going trough your application, use status filter and show only requests that Doctor is interested in the current UI section.

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

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

 

 

 

 

 

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Key

Value

Mandatory

Description

Example

Key

Value

Mandatory

Description

Example

1

 

 

 

 

 

2

 

 

 

 

 

3

 

 

 

 

 

Request data validation

Authorize

  • Verify the validity of access token

    • in case of error - return 401 (“Invalid access token”) in case of validation fails

  • Verify that token is not expired

    • in case of error - return 401 (“Invalid access token”)

  • Check user scopes in order to perform this action (scope = 'declaration:read')

    • return 403 (“Your scope does not allow to access this resource. Missing allowances: declaration:read”) in case of invalid scope(s)

Processing

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

Response structure examples

See on API-specification

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "data": [ { "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "declaration_number": "0000-12H4-245D", "employee": { "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "position": "P6", "employee_type": "doctor" }, "division": { "id": "asSbcy12sYs8c", "name": "Пединовка" }, "start_date": "2017-03-02", "end_date": "2017-03-02", "reason": "manual_employee", "reason_description": "Згідно постанови 1 від 10.01.20171111", "person": { "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "first_name": "Петро", "last_name": "Іванов", "second_name": "Миколайович", "birth_date": "1991" }, "legal_entity": { "short_name": "Ноунейм", "name": "Клініка Ноунейм", "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "edrpou": "5432345432" }, "declaration_request_id": "74a6fae6-4207-4e03-a136-f2e70c6b0c02", "inserted_at": "2017-04-20T19:14:13Z", "updated_at": "2017-04-20T19:14:13Z" } ], "paging": { "page_number": 2, "page_size": 50, "total_entries": 1000, "total_pages": 23 } }

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

 

401

 Invalid access token

 

 

4

 

403

 Your scope does not allow to access this resource. Missing allowances: declaration:read

 

 

5

Специфічні

6

 

 

 

 

 

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

 

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