Properties of a REST API method document

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)This method allows to add a role to an employee according to the type of medical service for which the role is being added.

Logic

1. Only authenticated and authorized user can use this service

2. Employee role must be valid and consistent, i.e. all "foreign keys" must be valid

3. It can be only one active employee_role for the single employee and healthcare service

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

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

{
  "healthcare_service_id": "98b6ed10-17b4-44f1-892c-7514f66bf505",
  "employee_id": "9d229fcb-6a77-4574-99a5-30729aa518fd"
}

Headers

Request data validation

Authorize

...

1. Verify the

...

Processing

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

Response structure examples

Description of the REST API response structure, example

...

...

1. validity of access token

   • return 401 in case validation fails

2. Check scopes in order to perform this action (scope = 'employee_role:write')

   • return 403 in case invalid scope(s)

3. If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at <= current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):

   • in case not match - return 403 ("Access denied. Party is not verified")

Validate request

Validate request using JSON schema

Validate legal entity

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

1. Extract client_id from token (token.client_id == legal_entity_id)

2. Check legal entity status (status = ACTIVE, SUSPENDED)

   1. In case of error - return 409 (Legal entity must be ACTIVE or SUSPENDED)

Validate FK

1. Validate healthcare_service_id - healthcare service exists and is_active = true

   1. Return 422 in case validation fails

2. Validate employee_id - employee exists and is_active = true

   1. Return 422 in case validation fails

Validate constraint

It can be only one active employee_role for the single employee and healthcare service

1. Check that there is no another active record (status = ACTIVE) with the same employee and healthcare service

   1. Return 409 (Duplicated employee role for this employee and healthcare service) in case such pair exists

Validate healthcare service

Check that healthcare service belongs to the same legal entity as the user and healthcare service is active

1. Extract client_id from token (token.client_id == legal_entity_id)

2. Validate legal entity on healthcare service

3. Check healthcare service status (status = ACTIVE)

Validate employee and its specialization

Check that employee belongs to the same legal entity as the user, employee is active and has the same specializations as the healthcare service

1. Extract client_id from token (token.client_id == legal_entity_id)

2. Validate legal entity on employee service

3. Check employee status (status = APPROVED)

4. Validate specialization on employee (where specialities.speciality_officio = true) and healthcare service

Processing

Save object to DB

Response structure examples

See on API-specification

{
  "meta": {
    "code": 201,
    "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

HTTP status codes

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

...