1 Purpose
2 Specification
3 Preconditions
4 Logic
5 Global and configuration parameters
6 Input parameters
7 Filters
8 Authorize
9 Headers
10 Request data validation
11 Processing
12 Response structure
13 Post-processing processes
14 HTTP status codes
15 Backward compatibility

Purpose

This method allows to get a list of scopes corresponding to the role by role name.

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

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

Global and configuration parameters

Input parameters

Filters

See on Apiary

Authorize

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

Headers

Content-Type:application/json

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "name": "Doctor",
      "scope": "notebooks:read notebooks:create patients:read",
      "id": "role-1380df72-275a-11e7-93ae-92361f002671"
    }
  ],
  "paging": {
    "limit": 20,
    "cursors": {
      "starting_after": "56c31536a60ad644060041af",
      "ending_before": "56c31536a60ad644060041aa"
    },
    "size": 50,
    "has_more": false
  }
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error

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

Backward compatibility

API paragraph not found

E-Health

List Roles

Purpose

Specification

Preconditions

Logic

Global and configuration parameters

Input parameters

Filters

Authorize

Headers

Request data validation

Processing

Response structure

Post-processing processes

HTTP status codes

Backward compatibility