• Purpose*

• Specification*

• Logic*

• Preconditions

• Global and configuration parameters

• Input parameters

• Filters

• Request structure*

• Authorize*

• Headers*

• Validate request (JSON schema)*

• Validation data request*

• Processing*

• Response structure*

• Post-processing processes*

• HTTP status codes

• Backward compatibility

Required parameters are marked with "*"

...

Purpose*

Purpose

Use this method to obtain a list of Declaration Requests for an empolee_id.

Key features

1. Only authenticated and authorized user can use declaration requests

Specification

...

Link	Apiaryhttps://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/declaration-requests/get-declaration-requests-list-v3
Resource	/api/v3/declaration_requests
Scope	declaration_request:read
Components	Необхідно зазначити перелік компонентів, які використовують цей метод, наприклад: ePrescription
Using Dictionaries	Потрібно вказати словники, які використовує метод API
Using Microservices	Вкажіть перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACDeclarations
Microservices	API paragraph not found
Protocol type	Вкажіть тип протоколу, який використовується запитом, наприклад: SOAP | REST | JSON
Request type	GET
Sync/Async	Метод є синхронним чи асинхронним?

Logic*

1. Only authenticated and authorized user can use declaration requests

If you want to reduce amount of data that is going trough your application, use status filter and show only requests that Doctor or Admin is interested in current UI section.

Also we suggest use employee_id and legal_entity_id to make sure that end-user understands context of actions that he or she will perform.

Method returns shortened details, to obtain full information - get Declaration Request it by it's ID.

Important

...

Logic

API paragraph not found

Filters

Request structure

...

API paragraph not found

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 = 'declaration_request:read')

   1. Return 403 in case invalid scope(s)

Request to process the request using a token in the headers.

Headers

...

• Content-Type:application/json

• Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Validate request (JSON schema)*

Наприклад:

1. Validate request using JSON schema

   1. In case validation failed - generate 422 error

...

...

Validation data request

...

API paragraph not found

Processing

...

API paragraph not found

Response structure

...

Expand
title Request example
Code Block { "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "data": [ { "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "start_date": "2017-03-02", "end_date": "2025-03-02", "status": "NEW", "person_id": "4fa9cac7-8950-44db-9294-0daba56eed58", "employee_id": "60a797bb-43c5-463d-86ee-68e354cb626b", "division_id": "4c9c9c6e-5230-444d-8b65-7678da1c1ab3", "legal_entity_id": "56b8bcd7-78b8-4ff7-8a60-a48e54a6ef57", "authorize_with": "cc949559-5dfe-420f-ac05-065e443b2cc6", "parent_declaration_id": "8c7753fc-a647-435f-8e43-4ff4546431f6" } ], "paging": { "page_number": 2, "page_size": 50, "total_entries": 1000, "total_pages": 23 } }

Post-processing processes

...

API paragraph not found

HTTP status codes

Backward compatibility

This endpoint returns declaration requests that were created through V2 and V3. Field person_id will be empty for declaration request V2.