...
Purpose*
Return list of participants (medications) of medical programs filtered by parameters.
Specification*
| Page Properties |
|---|
Link | https://uaehealthapi.docs.apiary.io/#reference/internal.-nhs-admin/black-list-users/get-black-list-user-list API paragraph not found | Resource | /black_list_users | Scope | bl_user:read | Components | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionAPI paragraph not found | Microservices | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABACAPI paragraph not found | Protocol type | Тип протоколу, який використовується запитом, наприклад: SOAP | 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 | Values | 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
Наприклад:
Content-Type:application/json
Validate request*
...
Request data validation*
API paragraph not found
Processing*
API paragraph not found
Response structure*
See on Apiary
Example:
| Expand |
|---|
|
| Code Block |
|---|
{
"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*
| Page Properties |
|---|
HTTP status code | Message | What caused the error |
|---|
200 | | |
|
...