Purpose

Returns information about the user whose ID is in the token

Specification

Link	https://uaehealthapi.docs.apiary.io/#reference/internal.-nhs-admin/user-details/get-user-details-by-id	Посилання на Apiary або Swagger
Resource	/oauth/user	Посилання на ресурс, наприклад: /api/persons/create
Scope	user:read	Scope для доступу
Components	Employees	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Internal. NHS Admin	Потрібно зазначити тип методу за ступенем доступності

Logic

API paragraph not found

Request structure

API paragraph not found

Authorize

API paragraph not found

Headers

Наприклад:

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

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": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
    "email": "example@gmail.com",
    "is_blocked": "false",
    "block_reason": "User has fakes data",
    "person_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "tax_id": "3126509816",
    "settings": {},
    "inserted_at": "2017-05-05T14:09:59.232112",
    "updated_at": "2017-05-05T14:09:59.232112"
  }
}

HTTP status codes

HTTP status code	Message	What caused the error
200	Response

Get user details by ID

Purpose

Specification

Logic

Request structure

Authorize

Headers

Request data validation

Processing

Response structure

HTTP status codes