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

Get equipment list

Owned by Dmytro Kulibaba (Unlicensed)
Last updated: Dec 03, 2024 by Oksana Demchenko
2 min read

Purpose

This WS is designed to return list of all active equipments related to legal entity. It is also allow to search for some equipments by search criteria

Specification

Link

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

Посилання на Apiary або Swagger

Resource

/api/equipment

Посилання на ресурс, наприклад: /api/persons/create

Scope

equipment:read

Scope для доступу

Components

Devices and equipment

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Public

Потрібно зазначити тип методу за ступенем доступності

Logic

Service returns all equipments related to legal_entity and filtered by passed query parameters:

  1. Get all equipments (PRM database)

  2. Filter by legal_entity (extract client_id from token)

  3. Filter list by passed search parameters (according to spec.)

    1. Search using like operation. Case insensitive

  4. Preload equipment names from prm.equipment_names

  5. Render a response according to specification

Filters

See on Apiary

Request structure

API paragraph not found

Authorize

  • Verify the validity of access token

    • Return (401, 'Invalid access token') in case of validation fails

  • Verify that token is not expired

    • in case of error - return (401, 'Invalid access token')

  • Check user scopes in order to perform this action (scope = 'equipment:read')

    • Return (403, 'Your scope does not allow to access this resource. Missing allowances: equipment:read') in case of invalid scope(s)

Headers

Наприклад:

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

api-key:uXhEczJ56adsfh3Ri9SUkc4en

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

Example:

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "data": [ { "id": "7c3da506-804d-4550-8993-bf17f9ee0402", "division_id": "8be63914-a278-470b-b868-1af5b9087332", "legal_entity_id": "483af06f-d4c6-4c9e-8d9b-680b5ef7270d", "type": "23143534", "external_id": "123-ASD-#1", "udi": [ { "value": "IMEI 49015420323751", "type": "default", "assigner_name": "Ukrainian center of the certification" } ], "lot_number": "RZ12345678", "manufacturer": "GlobalMed, Inc", "manufacture_date": "1999-01-01", "expiration_date": "2020-01-01", "model_number": "NSPX30", "part_number": "#e30-SD", "version": "v1.0.1", "name": "Рентген апарат флюрографічній", "serial_number": "S/N234554", "note": "Технічний огляд раз на рік", "status": "ACTIVE", "is_active": true, "inserted_at": "2017-04-20T19:14:13Z", "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e", "updated_at": "2017-04-20T19:14:13Z", "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd" } ], "paging": { "page_number": 2, "page_size": 50, "total_entries": 1000, "total_pages": 23 } }

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

200

 Response

 

 

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