/
[DRAFT] Get Program services list [API-011-001-007-0404]

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

[DRAFT] Get Program services list [API-011-001-007-0404]

Owned by Serhii Boldin (SoE eHealth) (Unlicensed)
Last updated: Dec 27, 2024 by Anzhela Kovalenko (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 Program services list [API-011-001-007-0404]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-011-001-007-0404

Microservices (namespace)

PRM

Component

Dictionaries and Registers

Component ID

COM-011-001

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

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

Resource

{{host}}/api/program_services

Scope

program_service:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This endpoint returns a list of service program members

Schema

Feature

Logic

N/A

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

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

    1. In case error - generate 403 response

Processing

N/A

Response structure examples

See on API-specification

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

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

 

403

 

 Invalid scope

 

4

Специфічні

5

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

Название

Название

Содержимое не найдено

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