Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] Get Role by ID [API-009-001-003-0331]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-009-001-003-0331
Microservices (namespace)	Mithril
Component	Mithril
Component ID	COM-009-001
Link на API-специфікацію	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/roles/get-role-by-id
Resource	{{host}}/admin/roles/{{id}}
Scope	role:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

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

Logic

This method returns role details (id/name/scopes) from mithril.roles by Role_ID

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1	id		String	Required	role-1380df72-275a-11e7-93ae-92361f002671
2

Request structure

See on API-specification

Headers

Request data validation

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

Processing

N/A

Response structure examples

See on API-specification

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

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200	Response
3		404	not_found	role with this ID not found in DB
4	Специфічні
5

Post-processing processes

N/A

Technical modules where the method is used

[DRAFT] Get Role by ID [API-009-001-003-0331]

Properties of a REST API method document

Purpose

Logic

Configuration parameters

Dictionaries

Input parameters

Request structure

Headers

Request data validation

Authorize

Processing

Response structure examples

HTTP status codes

Post-processing processes

Technical modules where the method is used