Required parameters are marked with "*"

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

Purpose*

Return list of participants (medications) of medical programs filtered by parameters.

Specification*

Link	https://uaehealthapi.docs.apiary.io/#reference/internal.-nhs-admin/black-list-users/get-black-list-user-list
Resource	/black_list_users
Scope	bl_user:read
Components	API paragraph not found
Microservices	API paragraph not found
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private/Internal	Internal

Logic*

Method returns list of participants (medications) of medical programs filtered by parameters.

Filters

Filter	Type	Description	Example
id	String	Black list user Identifier	`7124259c-eeb1-4cbb-acac-ada2162675d1`
tax_id	String	tax_id by party_id	`3126509816`
is_active	String	medical program name	`true`
page	Number	Page number	`2`
page_size	Number	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*

API paragraph not found

Response structure*

See on Apiary

Example:

Response example

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "tax_id": "3126509816",
      "is_active": true,
      "parties": [
        {
          "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
          "first_name": "Петро",
          "last_name": "Іванов",
          "second_name": "Миколайович",
          "birth_date": "1991-08-19"
        }
      ],
      "inserted_at": "2017-04-20T19:14:13Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
      "updated_at": "2017-04-20T19:14:13Z",
      "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
    }
  ],
  "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
200

Get Black list user list

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Filters

Request structure*

Authorize*

Headers*

Request data validation*

Processing*

Response structure*

Post-processing processes*

HTTP status codes*