Versions Compared

Key

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

Required parameters are marked with "*"

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

Purpose*

This method allows to get existing contract employees by its id for contracts with GB_CBP type through the NHS IT system

...

Page Properties

Link

https://uaehealthapi.docs.apiary.io/#reference/private.-contracts/private-contract-employees/private.-get-contract-employee-by-id

Resource

/api/admin/contract_employees/{{id}}

Scope

private_contracts:read

Components

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC

Protocol type

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Sync/Async

Метод є синхронним чи асинхронним?

Logic*

API paragraph not found

...

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • api-key:c2778f3064753ea70de870a53795f5c9

Request data validation*

Validate request

...

  1. Only authenticated and authorized user can use this service

  2. Deleted records won't be shown in response

Request data validation*

...

Processing*

  1. Show requested contract employees for contracts with type = GB_CBP

...