Versions Compared

Old Version 14

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

Saved on

compared with

New Version Current

changes.mady.by.user Georgiy Lysenko (Unlicensed)

Saved on

Key

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

Purpose

...

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

Specification

...

Page Properties

Link

API paragraph not foundhttps://uaehealthapi.docs.apiary.io/#reference/internal.-nhs-admin/party-users/get-party-users-list

Resource

/party_users

Scope

party_user:read

Components

Employees

Microservices

API paragraph not foundil/api

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private/Internal

InternalPrivate

Logic*

API paragraph not found

...

Input parameters

See on Apiary

Filters

See on Apiary

Filter

Values

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*

API paragraph not found

Authorize

...

Request to process the request using a token in the headers

Request structure

See on Apiary

Headers

...

Наприклад:

  • Content-Type:application/json

Request data validation*

...

Processing*

API paragraph not found

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

Post-processing processes*

API paragraph not found

HTTP status codes

...

Page Properties

HTTP status code

Message

What caused the error

 200

  Response