| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
| Info |
|---|
/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document) |
Properties of a REST API method document
| Page Properties |
|---|
| id | page_properties_method_REST API |
|---|
|
Document type | Метод REST API |
|---|
Document title | [DRAFT] REST API Get Forbidden group details [API-001-001-002-0008] |
|---|
Guideline ID | GUI-0011 |
|---|
Author | @ |
|---|
Document version | 1 |
|---|
Document status | DRAFT |
|---|
Date of creation | ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD) |
|---|
Date of update | ХХ.ХХ.ХХХХ (дата зміни версії) |
|---|
Method API ID | API-001-001-002-0008 |
|---|
Microservices (namespace) | ABAC |
|---|
Component | Approvals/ABAC |
|---|
Component ID | COM-001-001 |
|---|
Link на API-специфікацію | https://ehealthmisapi1.docs.apiary.io/#reference/public.-forbidden-groups/get-forbidden-group-details/get-forbidden-group-details |
|---|
Resource | {{host}}/api/forbidden_groups/{{id}} |
|---|
Scope | forbidden_group:read |
|---|
Protocol type | REST |
|---|
Request type | GET |
|---|
Sync/Async | Sync |
|---|
Public/Private | Public |
|---|
|
Purpose
Return forbidden group details filtered by ID with active codes and active services in eHealth.
Key points
This is a REST method used by MIS
Authorization is not needed to get Forbidden group list (as dictionaries)
Logic
This web service returns forbidden group details filtered by ID with active codes and active services in eHealth.
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
| Input parameter | Mandatory | Type | Description | Example |
|---|
| 1 | id | | String | | b075f148-7f93-4fc2-b2ec-2d81b19a9b7b
|
| 2 | | | | | |
Request structure
See on API-specification
Headers
Request data validation
N/A
Processing
N/A
Response structure examples
See on API-specification
| Expand |
|---|
|
| Code Block |
|---|
| {
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "req-adasdoijasdojsda"
},
"data": [
{
"id": "f7f817b2-3134-4625-b87d-e2d7fc8e9b90",
"name": "Some name",
"creation_reason": "Some text",
"deactivation_reason": "Some text",
"forbidden_group_codes": [
{
"id": "f016a994-4826-48ae-be65-8d459a75f021",
"code": "G30.9",
"system": "eHealth/ICD10_AM/condition_codes",
"creation_reason": "Some text"
}
],
"forbidden_group_services": [
{
"id": "b8bc70e1-783c-4b25-a90e-0da9217d84d9",
"service_id": "b2e4464e-609e-480c-a32c-6db4fbb04cf1",
"service_group_id": "d838dbea-0ca0-4295-bf46-819dc069b8d4",
"creation_reason": "Some text"
}
]
}
]
} |
|
HTTP status codes
| Response code | HTTP Status code | Message | Internal name | Description |
|---|
| 1 | Базові |
| 2 | | 200 | | | |
| 3 | | | | | |
| 4 | Специфічні |
| 5 | | | | | |
Post-processing processes
N/A
Technical modules where the method is used
| Page Properties Report |
|---|
| headings | ID ТМ, Статус |
|---|
| cql | label = "tr-mis" |
|---|
|