Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

1 Properties of a REST API method document
2 Purpose
3 Logic
4 Configuration parameters
5 Dictionaries
6 Input parameters
7 Request structure
8 Headers
9 Request data validation
- 9.1 Authorize
10 Processing
11 Response structure examples
12 HTTP status codes
13 Post-processing processes
14 Technical modules where the method is used

Properties of a REST API method document

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

Purpose

This WS is designed to return employee role details. Search employee role possible by Employee role identifier.

Logic

Only authenticated and authorized user can use this service
Service returns only employee roles related to the same legal entity as the user

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

	Input parameter	Mandatory	Type	Description	Example

Input parameter

Mandatory

Type

Description

Example

1

id

String

Employee role identifier.

Optional

d290f1ee-6c54-4b01-90e6-d701748f0851

2

Request structure

See on API-specification

Headers

	Key	Value	Mandatory	Description	Example

	Key	Value	Mandatory	Description	Example
1
2
3

Request data validation

Authorize

Verify the validity of access token
1. Return 401 in case validation fails
Check scopes in order to perform this action (scope = 'employee_role:read')
1. Return 403 in case invalid scope(s)

Check that employee role with such ID exists in the system (is_active = true)
1. In case of error - return 404
Check that employee role with such ID belongs to to the same legal entity as the user
1. In case of error - return 403

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

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": {
    "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
    "healthcare_service_id": "98b6ed10-17b4-44f1-892c-7514f66bf505",
    "employee_id": "9d229fcb-6a77-4574-99a5-30729aa518fd",
    "start_date": "2019-04-20T19:14:13Z",
    "end_date": "2017-12-20T19:14:13Z",
    "status": "ACTIVE",
    "is_active": true,
    "inserted_at": "2017-04-20T19:14:13Z",
    "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
    "updated_at": "2017-04-20T19:14:13Z",
    "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
  }
}

HTTP status codes

	Response code	HTTP Status code	Message	Internal name	Description

	Response code	HTTP Status code	Message	Internal name	Description
1	Базові
2		201	Response
3		401	Invalid access token
4		403	Check that employee role with such ID belongs to to the same legal entity as the user failed
5		403	Invalid scope(s)
6		404	Check that employee role with such ID exists in the system (is_active = true) failed
7	Специфічні
8

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

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

[DRAFT] Get employee role by ID [API-005-007-004-0126]