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

Get Declarations List (Internal method)

Purpose

Using this method it's possible to see the list of all declarations which belongs to a person (knowing person_id) or one particular declartion knowing its' id or declaration_number.

Also it's possible to sort declatations either by:

start_date

status

By defaut the result is sorted by start_date:desc

Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-nhs-admin-v2/declarations/get-declarations-list

Resource

 

Scope

declaration:read

Components

Declarations

Microservices

 

Protocol type

 

Request type

GET

Sync/Async

 

Public/Private/Internal

Internal

 

Logic

Input parameters

 

Input parameter

Values

Type

Description

Example

Input parameter

Values

Type

Description

Example

 sort

 

 enum

  • start_date:desc

  • start_date:asc

  • status:desc

  • status:asc:desctart_date:ascstatus:descsttus:asc

 start_date

Filters

Name

Type

Value

Example

Name

Type

Value

Example

id

string

declaration ID

d290f1ee-6c54-4b01-90e6-d701748f0851

person_id

string

MPI ID

d290f1ee-6c54-4b01-90e6-d701748f0851

declaration_number

string

unique human redable number of declaration

0000-12H4-245D

page

number

Page number

2

page_size

number

A limit on the number of objects to be returned, between 1 and 300. Default: 50

50

Global and configuration parameters

Preconditions

Request structure

Authorize

 

Headers

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

 

Validate request

Request data validation

 

Processing

API paragraph not found

 

Response structure

See APIary

Example:

{ "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", "legal_entity": { "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "name": "Клініка Ноунейм", "short_name": "Ноунейм", "public_name": "Клініка Ноунейм", "type": "MSP", "edrpou": "5432345432", "status": "ACTIVE", "addresses": [ { "type": "RESIDENCE", "country": "UA", "area": "Житомирська", "region": "Бердичівський", "settlement": "Київ", "settlement_type": "CITY", "settlement_id": "b075f148", "street_type": "STREET", "street": "вул. Ніжинська", "building": "15", "apartment": "23", "zip": "02090" } ] }, "start_date": "2017-03-02", "end_date": "2017-03-02", "signed_at": "2017-03-02T10:45:16.000Z", "person": { "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b", "first_name": "Петро", "last_name": "Іванов", "second_name": "Миколайович", "birth_date": "1991-08-19", "birth_country": "Україна", "birth_settlement": "Вінниця", "gender": "MALE" }, "secret": "secret", "documents": [ { "type": "PASSPORT", "number": "АА120518", "expiration_date": "2021-02-28", "issued_by": "Рокитнянським РВ ГУ МВС Київської області", "issued_at": "2017-02-28" } ], "addresses": [ { "type": "RESIDENCE", "country": "UA", "area": "Житомирська", "region": "Бердичівський", "settlement": "Київ", "settlement_type": "CITY", "settlement_id": "b075f148", "street_type": "STREET", "street": "вул. Ніжинська", "building": "15", "apartment": "23", "zip": "02090" } ], "phones": [ { "type": "MOBILE", "number": "+380503410870" } ], "authentication_methods": [ { "type": "OTP", "phone_number": "+38093*****85" } ], "preferred_way_communication": "email", "division": { "id": "asSbcy12sYs8c", "name": "Пединовка", "addresses": [ { "type": "RESIDENCE", "country": "UA", "area": "Житомирська", "region": "Бердичівський", "settlement": "Київ", "settlement_type": "CITY", "settlement_id": "b075f148", "street_type": "STREET", "street": "вул. Ніжинська", "building": "15", "apartment": "23", "zip": "02090" } ], "phones": [ { "type": "MOBILE", "number": "+380503410870" } ], "email": "email@example.com", "status": "ACTIVE", "ACTIVE": "", "INACTIVE": "", "type": "clinic", "CLINIC": "", "AMBULANT_CLINIC": "", "FAP": "", "mountain_group": false }, "employee": { "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "position": "P8", "start_date": "2017-03-02T10:45:16.000Z", "end_date": "2018-03-02T10:45:16.000Z", "status": "APPROVED", "employee_type": "DOCTOR", "party": { "first_name": "Петро", "last_name": "Іванов", "second_name": "Миколайович" }, "doctor": { "specialities": [ { "speciality": "THERAPIST", "speciality_officio": true, "level": "FIRST", "qualification_type": "AWARDING", "attestation_name": "Академія Богомольця", "attestation_date": "2017-02-28", "valid_to_date": "2020-02-28", "certificate_number": "AB/21331" } ] } }, "scope": "family_doctor", "declaration_request_id": "74a6fae6-4207-4e03-a136-f2e70c6b0c02", "reason": "manual_employee", "reason_description": "Згідно постанови 1 від 10.01.2017" } ], "paging": { "page_number": 2, "page_size": 50, "total_entries": 1000, "total_pages": 23 } }

Post-processing processes

API paragraph not found

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

200

Response

 

 

 

 

 

 

 

 

Backward compatibility

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