Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

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).

...

Specification

Apiary

Search params

  • forbidden group name

Filters

Filter

Values

Type

Description

Example

name

String

Forbidden group name

Some name

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned, between 1 and 100

50

Headers

Наприклад:

  • Content-Type:application/json

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
titleResponse 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