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

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

Owned by Kateryna Yakovleva
Last updated: Nov 25, 2024 by Anastasiia Prokhorova (SoE eHealth)
2 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

[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-005-007-002-0113

Microservices (namespace)

IL

Component

Employees

Component ID

COM-005-007

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

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

Resource

{{host}}/api/employee_requests

Scope

employee_request:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

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

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

 

 

 

 

 

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Headers

Request data validation

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

{ "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

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 Response

 

 

3

 

401

Invalid access token

 

 

4

 

403

Access denied

 

 

5

 

403

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

 

 

6

Специфічні

7

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

 

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