Logic*

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

...

Key points

1. This is a REST method used by MIS

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

Input parameters

Request structure*

API paragraph not found

Authorize*

Request to process the request using a token in the headers

Headers*

Наприклад:

• Content-Type:application/json

Validate request*

...

Request data validation*

API paragraph not found

Processing*

Search params

• forbidden group name

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:

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

...