Table of Contents

Page Properties

id	API_Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/roles/list-roles	Посилання на Apiary або Swagger
Resource	/admin/roles	Посилання на ресурс, наприклад: /api/persons/create
Scope	role: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	Потрібно зазначити тип методу за ступенем доступності

Preconditions

Logic

API paragraph not foundThis method returns list of roles with id/name/scopes from mithril.roles. Can be used with or without search params.

...

See on Apiary

...

Verify the validity of access token
1. in case error return 401 Unauthorized
Check users scopes (role:read) to perform this action
1. in case error return 403 - forbidden

Content-Type:application/json

...

Page Properties

id	API_HTTP status codes

HTTP status code	Message	What caused the error
200	Response
401	Unauthorized	invalid token

API paragraph not found