REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

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-0127
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/deactivate-employee-role
Resource	{{host}}api/employee_roles/{{id}}/actions/deactivate
Scope	employee_role:write
Protocol type	REST
Request type	PATCH
Sync/Async	Sync
Public/Private	Public

Purpose

This method allows to deactivate a previously added employee role

Logic

Only authenticated and authorized user can use this service
Only ACTIVE employee role can be deactivated
Legal entity can deactivate only its own employee roles

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

Description of input parameters

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 (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Example

Headers

	Key	Value	Mandatory	Description	Example
1	Content-Type	application/json	M	Тип контенту	Content-Type:application/json
2
3

Request data validation

Validate legal entity

Check that legal entity is active (status = ACTIVE, SUSPENDED)

Extract client_id from token (token.client_id == legal_entity_id)
Check legal entity status (status = ACTIVE, SUSPENDED)
1. In case of error - return 409 (Legal entity must be ACTIVE or SUSPENDED)

Validate employee role

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 belongs to the same legal entity as the user
1. In case of error - return 403

Validate transition

Only ACTIVE employee role can be deactivated

Available transitions

ACTIVE → INACTIVE

In other cases - return 409 error ('{current_status} employee role cannot be DEACTIVATED')

Processing

Update object in DB

Parameter	Source	Description
end_date	Timestamp: now()	Get current date-time
status	Const: INACTIVE
updated_at	Timestamp: now()	Get current date-time
updated_by	Token: user_id

Response structure examples