Table of Contents

Page Properties

id	API_Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/healthcare-services/add-employee-role	Посилання на Apiary або Swagger
Resource	/api/employee_roles	Посилання на ресурс, наприклад: /api/persons/create
Scope	employee_role:write	Scope для доступу
Components	Scopes model	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	POST	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Logic

Only authenticated and authorized user can use this service
Employee role must be valid and consistent, i.e. all "foreign keys" must be valid
It can be only one active employee_role for the single employee and healthcare service

Input parameters

ATTRIBUTES - see on Apiary

Example:

...

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

Наприклад:

...