Table of Contents

Page Properties

id	API_Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/employee-roles/get-employee-role-by-id	Посилання на Apiary або Swagger
Resource	api/employee_roles/{{id}}	Посилання на ресурс, наприклад: /api/persons/create
Scope	employee_roles:read	Scope для доступу
Components	Scopes model	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: 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	Public	Потрібно зазначити тип методу за ступенем доступності

Logic

Only authenticated and authorized user can use this service
Service returns only employee roles related to the same legal entity as the user

Input parameters

Input parameter

Values

Type

Description

Example

id

String

Employee role identifier.

Optional

d290f1ee-6c54-4b01-90e6-d701748f0851

API paragraph not found

...

Verify the validity of access token
1. Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'employee_role:read')
1. Return 403 in case invalid scope(s)

Наприклад:

Content-Type:application/json

...