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

Get Program services list

Owned by Aleksandra Novokhatnia (Deactivated)
Last updated: Jan 20, 2023 by Dmytro Kulibaba (Unlicensed)
2 min read

Purpose

This endpoint returns a list of service program members

Schema

Feature

Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-programs/medical-program/get-program-services-list

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

Resource

/api/program_services

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

Scope

program_service:read

Scope для доступу

Components

Medical Programs

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: 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

API paragraph not found

Input parameters

No

Filters

See on Apiary

Request structure

API paragraph not found

Authorize

  1. Check user scope (scope = 'program_service:read') in order to perform this action

    1. In case error - generate 403 response

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

See on Apiary

Example:

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "data": [ { "id": "c290f1ee-6c54-4b01-90e6-d701748f0851", "medical_program_id": "b290f1ee-6c54-4b01-90e6-d701748f0852", "service_id": "d290f1ee-6c54-4b01-90e6-d701748f0853", "service_group_id": "null", "consumer_price": 15, "description": "text", "request_allowed": true, "is_active": true, "inserted_at": "2019-04-20T19:14:13Z", "inserted_by": "f290f1ee-6c54-4b01-90e6-d701748f0851", "updated_at": "2019-04-20T19:14:13Z", "updated_by": "f290f1ee-6c54-4b01-90e6-d701748f0851" } ], "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

 

 403

 

 Invalid scope

 

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