Table of Contents

minLevel	1
maxLevel	3

...

Purpose

...

Method returns list of user_id(s) by party_id(s) filtered by parameters.

Specification

...

Page Properties
Project Name
COVID-certificate
Project abreviation
SVC
Developer
Розробник методу API. Наприклад, Edenlab
Project Manager
@Єлизавета Гессен-Дармштадська
Tech Lead
@Іоанн Воїнов
Product Owner
@Нікодім Святогорцев
Вusiness analyst
@Пантелеймон Нікомедійський
Status
Status
colour Green
title APPROVED
Version
1.0
Date of release
22 Jun 2022
Link
https://uaehealthapi.docs.apiary.io/#reference/internal.-nhs-admin/party-users/get-party-users-list
Resource
/party_users
Scope
party_user:read
Components
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionEmployees
Microservices
Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACil/api
Protocol type
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
Request type
GET
Sync/Async
Метод є синхронним чи асинхронним?

Logic*

Method returns list of user_id(s) by party_id(s) filtered by parameters.

Filters

Sync
Public/Private/Internal	Private

Input parameters

See on Apiary

Filters

See on Apiary

Filter	Type	Description	Example
user_id	String	user Identifier	`09106b70-18b0-4726-b0ed-6bda1369fd52`
party_id	String	Party Identifier	`79a91507-d409-49fc-b373-934b59c4f694`
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*

...

Authorize

...

Request to process the request using a token in the headers

Request structure

See on Apiary

Headers

...

Наприклад:
Content-Type:application/json

Validate request*

API paragraph not found

Request data validation*

API paragraph not found

...

API paragraph not found

Response structure

...

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "585044f5-1272-4bca-8d41-8440eefe7d26",
      "user_id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
      "party_id": "79a91507-d409-49fc-b373-934b59c4f694",
      "first_name": "Петро",
      "last_name": "Іванов",
      "second_name": "Миколайович",
      "birth_date": "1991-08-19T00:00:00.000Z",
      "inserted_at": "2017-04-20T19:14:13Z",
      "updated_at": "2017-04-20T19:14:13Z"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

Page Properties
Project Name	COVID-certificate
Project abreviation	SVC
Developer	Розробник методу API. Наприклад, Edenlab
Project Manager	@Єлизавета Гессен-Дармштадська
Tech Lead	@Іоанн Воїнов
Product Owner	@Нікодім Святогорцев
Вusiness analyst	@Пантелеймон Нікомедійський
Status

Date of release	22 Jun 2022
Link	https://uaehealthapi.docs.apiary.io/#reference/internal.-nhs-admin/party-users/get-party-users-list
Resource	/party_users
Scope	party_user:read
Components	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescriptionEmployees
Microservices	Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABACil/api
Protocol type	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET
Sync/Async	Метод є синхронним чи асинхронним?

Versions Compared

Old Version 1

New Version Current

Key

Purpose

Method returns list of user_id(s) by party_id(s) filtered by parameters.

Specification

Logic*

Filters

Input parameters

Filters

Request structure*

Authorize

Request to process the request using a token in the headers

Request structure

Headers

Наприклад:
Content-Type:application/json

Validate request*

Request data validation*

Response structure

Post-processing processes*

HTTP status codes

Page Properties
HTTP status code
Message
What caused the error
200
Response

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Purpose

Method returns list of user_id(s) by party_id(s) filtered by parameters.

Specification

Logic*

Filters

Input parameters

Filters

Request structure*

Authorize

Request to process the request using a token in the headers

Request structure

Headers

Наприклад:Content-Type:application/json

Validate request*

Request data validation*

Response structure

Post-processing processes*

HTTP status codes

Page PropertiesHTTP status codeMessageWhat caused the error 200 Response

Наприклад:
Content-Type:application/json

Page Properties
HTTP status code
Message
What caused the error
200
Response