Versions Compared

Old Version 9

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Serhii Boldin (SoE eHealth)

Saved on

Key

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

...

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

Request structure

...

Authorize

Request to process the request using a token in the headers

Headers

Наприклад:

  • Content-Type:application/json

Request data validation

...

Processing

Service logic

  1. Filter active forbidden_groups by search params

  2. Render found forbidden_groups with following params only:

    1. id

    2. name

...

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

Post-processing processes

...

HTTP status codes
HTTP status code
Message
What caused the error
 200
 
 
...