1 Purpose
2 Specification
3 Preconditions
4 Logic
5 Input parameters
6 Authorize
7 Headers
8 Request data validation
- 8.1 Validate legal entity
- 8.2 Validate employee role
- 8.3 Validate transition
9 Processing
- 9.1 Update object in DB
10 Response structure
11 HTTP status codes

Purpose

This method allows to deactivate a previously added employee role

Specification

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/employee-roles/deactivate-employee-role	Посилання на Apiary або Swagger
Resource	/api/employee_roles/{{id}}/actions/deactivate	Посилання на ресурс, наприклад: /api/persons/create
Scope	employee_role:write	Scope для доступу
Components	Employees	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	il/api	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PATCH	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Preconditions

The user must have an active 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

Input parameters

Input parameter	Values	Type	Description	Example

Input parameter

Values

Type

Description

Example

id

String

Employee role identifier.

Optional

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

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:write')
1. Return 403 in case invalid scope(s)

Headers

Content-Type:application/json

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

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

Example:

{
  "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": "INACTIVE",
    "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

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200	Response
401		Invalid access token
403		Invalid scope(s) Check that employee role belongs to the same legal entity as the user failed
404		Validation error
409		Validation error

E-Health

Deactivate employee role