1 Purpose*
2 Specification*
3 Logic*
- 3.1 Key points
4 Input parameters
5 Request structure*
6 Authorize*
7 Headers*
8 Request data validation*
9 Processing*
- 9.1 Search params
- 9.2 Service logic
10 Response structure*
11 Post-processing processes*
12 HTTP status codes*

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “API paragraph not found”.

Purpose*

This WS allows to get list of forbidden groups without details by legal entity employees. Used to get id and name of the forbidden group to achieve permissions on it with help of approval

Specification*

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-forbidden-groups/get-forbidden-group-list/get-forbidden-group-list
Resource	/api/forbidden_groups
Scope	forbidden_group:read
Components	API paragraph not found
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Sync

Logic*

This web service returns a catalog of all active forbidden groups in eHealth.

Key points

This is a REST method used by MIS
Authorization is not needed to get Forbidden group list (as dictionaries).

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter	Type	Description	Example
name	String	Forbidden group name	`Some name`
page	Numbe	Page number	`2`
page_size	Numbe	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`

Request structure*

API paragraph not found

Authorize*

Request to process the request using a token in the headers

Headers*

Наприклад:

Content-Type:application/json

Request data validation*

API paragraph not found

Processing*

Search params

forbidden group name

Service logic

Filter active forbidden_groups by search params
Render found forbidden_groups with following params only:
1. id
2. name

Response structure*

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "f7f817b2-3134-4625-b87d-e2d7fc8e9b90",
      "name": "Some name"
    }
  ],
  "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

E-Health

Get Forbidden group list

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Key points

Input parameters

Request structure*

Authorize*

Headers*

Request data validation*

Processing*

Search params

Service logic

Response structure*

Post-processing processes*

HTTP status codes*