Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] PIS. Get legal entities parties (Bulk data export) [API-005-012-004001-04800476]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-005-012-004001-04800476

Microservices (namespace)

IL

Component

Bulk export

Component ID

COM-005-012

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

https://pisapi1.docs.apiary.io/#reference/public.-patient-information-system/bulk-data-export/get-legal-entitiesparties

Resource

{{host}}/api/pis/bulk/legal_entitiesparties

Scope

legal_entityparty_bulk:read_pis

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

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

...

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

  2. Generate file that contains all the data from legal_entities parties 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

...

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

Expand
titleExample
Code Block
languagejson

...

  • 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 = 'legal_entityparty_bulk:read_pis')

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

...

Validate parameters by type and format

Parameter

Type

Format

depth

integer

Positive number without fraction components

Processing

N/A

Response structure examples

See on API-specification

Expand
titleExample
Code Block
languagejson

...