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)

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 This method allows to re-send the composition to ERLN (Electronic Register of temporary disability conclusions of the Pension Fund of Ukraine). Used only for the type of compositions - Тemporary Disability

Used in processes:

4. Re-sending Тemporary Disability Composition to ERLN

Logic

This method allows to re-send Тemporary Disability Composition to ERLN in cases when the previous attempt of ERLN registration was unsuccessful, the description of the error is available and if all checks is passed.

Precondition:

• Composition status is “FINAL”

• Previous attempt of ERLN registration was unsuccessful (“ERROR” integration status)

• The description of the error is available (statusMessage isn’t empty)

• Temporarily disabled person is identified in the System (section.focus.type.coding.code = person)

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

Headers

Headers

...

Request data validation

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

Authorization

...

Bearer c2778f3064753ea70de870a53795f5c9

...

M

...

Перевірка користувача

...

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

...

Request data validation

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

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

Response structure examples

...

Authorize

Check user scopes in order to perform this action (scope = 'composition:create')

• return 401 (Unauthorized) in case of invalid scope(s)

Validation data request

1. Searching for the last scheduled ERLN task for this composition

   1. In case of error (ERLN task not found) - return 404 ('Not Found')

2. Searching for the composition

   1. In case of error (composition was not found) - return 404 ('Not Found')

3. Check the composition’s type

   1. In case of error (composition’s type isn’t Тemporary Disability) - return 400 ('Bad Request')

4. Check the composition’s status

   1. In case of error (composition’s status isn’t “FINAL”) - return 400 ('Bad Request')

5. Check the composition’s integration status

   1. In case of error (composition’s integration status isn’t “ERROR”) - return 400 ('Bad Request')

6. Check the previous task status

   1. In case of error (task status is still in progress) - return 400 ('Bad Request')

In case if all previous checks were passed the function creates a new call task into ERLN, and completes its work with code 200

Processing

N/A

Response structure examples

See on API-specification

{
  "data": {
    "eta": "2022-10-24T12:35:49.956Z",
    "id": "89678f60-4cdc-4fe3-ae83-e8b3ebd35c59",
    "links": [
      {
        "entity": "eHealth/resources"
      }
    ],
    "status": "PENDING"
  }
}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 N/A

Technical modules where the method is used

...