Properties of a REST API method document

Purpose

Describe the purpose of the API method, add Key points (if necessary)This method returns details of the specified capitation report

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 parameters

Request structure

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

Description of the REST API request structure, example

Headers

Request data validation

...

Request data validation

Authorize

1. Verify the validity of access token

   1. in case of error return 401 ('Access denied')

2. Check user scope capitation_report:read in order to perform this action

   1. in case of error generate 401 response ('Invalid scopes')

Verify role

Extract from token:

1. Validate client_id (is_blocked=false)

   1. in case of error return 403 Error ('Client is blocked')

2. In case WS was called by MSP check contractor_legal_entity is active

   • in case error return 403 - ('Client is not active')

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, exampleSee on API-specification

1. Generate synthetical id for each object in response

   1. id = edrpou +  '-' + report_id

2. In case WS was called by NHS

   1. Select all capitation_report_details by id

   2. Return the result

3. In case WS was called by MSP

   1. Extract legal_entity_id from token

   2. search for merged_from_legal_entities 

   3. Select capitation_report_details where legal_entity_id = legal_entity_id (from step a) and legal_entity_id = merged_from_legal_entities_id (from step b)

   4. Return the result

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "29000165-09106b70-18b0-4726-b0ed-6bda1369fd52",
      "biling_date": "2017-04-20",
      "report_id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
      "legal_entity_id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
      "edrpou": "29000165",
      "legal_entity_name": "Поліклініка для Капітації",
      "capitation_contracts": [
        {
          "contract_id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
          "contract_number": "0000-9EAX-XT7X-3115",
          "details": [
            {
              "mountain_group": true,
              "attributes": {
                "0-5": 17,
                "6-17": 7,
                "18-39": 9,
                "40-65": 12,
                "65+": 15
              }
            },
            {
              "mountain_group": false,
              "attributes": {
                "0-5": 22,
                "6-17": 10,
                "18-39": 15,
                "40-65": 19,
                "65+": 21
              }
            }
          ],
          "total": {
            "attributes": {
              "0-5": 39,
              "6-17": 17,
              "18-39": 24,
              "40-65": 31,
              "65+": 36
            }
          }
        }
      ]
    }
  ]
}

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

...