Required parameters are marked with "*"

...

Purpose

...

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

Specification

...

Page Properties
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 Forbidden groups Microservices API paragraph not found Protocol type API paragraph not found Request type GET Sync/Async Sync Public/Private/Internal Public

Logic

...

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

Key points

1. This is a REST method used by MIS

2. Authorization is not needed to get Forbidden group list (as dictionaries).

Filters

Request structure*

...

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

...

Service logic

1. Filter active forbidden_groups by search params

2. Render found forbidden_groups with following params only:

   1. id

   2. name

Response structure

...

See on Apiary

Example:

Expand
title Response example
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" } ], "paging": { "page_number": 2, "page_size": 50, "total_entries": 1000, "total_pages": 23 } }

HTTP status codes

...

HTTP status code	Message	What caused the error
200