Properties of a REST API method document

Document type	Метод REST API
Document title	[DRAFT] Get Rule engine rule list [API-005-005-001-0085]
Guideline ID	GUI-0011
Author	@
Document version	1
Document status	DRAFT
Date of creation	ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)
Date of update	ХХ.ХХ.ХХХХ (дата зміни версії)
Method API ID	API-005-005-001-0085
Microservices (namespace)	IL
Component	Dictionaries and Registers
Component ID	COM-005-005
Link на API-специфікацію	https://medicaleventsmisapi.docs.apiary.io/#reference/rule-engine-rules/get-rule-engine-rule-list/get-rule-engine-rule-list
Resource	{{host}}/api/rule_engine_rules
Scope	rule_engine_rule:read
Protocol type	REST
Request type	GET
Sync/Async	Sync
Public/Private	Public

Purpose

This WS allows to get list of rule engine rules without rules details. Used to get by id, name or code of the rule engine rule.

Key points

This is a REST method used by MIS.
Only authenticated and authorized employee with appropriate scope can get rule engine rules list.

Logic

Filter rule_engine_rules
1. with is_active=true status
2. by search params
Render a response according to specification.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

	Input parameter	Mandatory	Type	Description	Example

	Input parameter	Mandatory	Type	Description	Example
1
2

Request structure

See on API-specification

Headers

Request data validation

Authorize

Verify the validity of the access token
- in case of error - return 401 (“Invalid access token”)
Verify that token is not expired
- in case of error - return 401 (“Invalid access token”)
Check user scopes in order to perform this action (scope = 'rule_engine_rule:read')
- in case of invalid scope(s) - return 403 (“Your scope does not allow to access this resource. Missing allowances: rule_engine_rule:read”)

Processing

name. Search by rule_engine_rules.name
code. Searches by rule_engine_rules.code.code
system. Searches by rule_engine_rules.code.system

Response structure examples

See on API-specification

{
  "data": [
    {
      "id": "1f8444a0-e48b-440b-a082-c4703233efa2",
      "name": "Some name",
      "code": {
        "system": "eHealth/clinical_impression_patient_categories",
        "code": "insulin_1"
      }
    }
  ],
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		200
3		401	Invalid access token
4		403	Your scope does not allow to access this resource. Missing allowances: rule_engine_rule:read
5	Специфічні
6

Post-processing processes

N/A

Technical modules where the method is used

Название	ID ТМ	Статус

Название	ID ТМ	Статус
RC-V.2.1 [TM-011] Відхилення ЕР фармацевтом	TM0112
RC-V.2.1 [TM-011] Відхилення ЕР фармацевтом

[DRAFT] Get Rule engine rule list [API-005-005-001-0085]

Properties of a REST API method document

Purpose

Key points

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