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

Purpose

Method to Get all employees from ehealth system as a raw data as a part of data exchange to do some operations on PIS side (data enrichment, search)

Logic

Service logic

Prepare snapshot (cron)

1. Run cron-job to prepare data based on schedule (EMPLOYEES_BULK_UPLOAD_SCHEDULE)

2. Generate file that contains all the data from employees table

3. Generate N files depending on PIS_BULK_ACTIONS_MAX_DEPTH with data changed in 1-2-3 .. N days

4. Upload files to MEDIA_STORAGE_BULK_ACTIONS_BUCKET

Retrieve data

1. Download file from media storage MEDIA_STORAGE_BULK_ACTIONS_BUCKET depending on requested depth

   1. If depth is missing - get all records

   2. if depth is passed - select file that contains changes within requested period

2. Retrieve records from file and render as response

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorization

• Verify that MIS API token exists in request

  • in case of error - return 401 (“Api key is not set")

• Verify the validity of MIS API token

  • in case of error - return 401 (“Invalid api key”)

• Verify that MIS API token is not expired

  • in case of error - return 401 (“Invalid api key”)

• Check MIS scopes in order to perform this action (scope = 'employee_bulk:read_pis')

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

Validate query parameters

Validate parameters by type and format

Processing

N/A

Response structure examples

See on API-specification

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used