ЕСОЗ - публічна документація

Get Role by ID

Owned by Dmytro Kulibaba (Unlicensed)
Last updated: Aug 16, 2023 by Oksana Demchenko
1 min read

Purpose

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

Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/roles/get-role-by-id

Посилання на Apiary або Swagger

Resource

/admin/roles/{{id}}

Посилання на ресурс, наприклад: /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 role details (id/name/scopes) from mithril.roles by Role_ID

Global and configuration parameters

Input parameters

Input parameter

Values

Type

Description

Example

Input parameter

Values

Type

Description

Example

id

 

String

Required

role-1380df72-275a-11e7-93ae-92361f002671

Filters

Dictionaries

Request structure

API paragraph not found

Authorize

  1. Verify the validity of access token

    1. in case error return 401 Unauthorized

  2. Check users scopes (role:read) to perform this action

    1. in case error return 403 - forbidden

Headers

API paragraph not found

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" } }

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

 

404

not_found

role with this ID not found in DB

401

Unauthorized

invalid token

Backward compatibility

API paragraph not found

ЕСОЗ - публічна документація