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 parameters

This WS allows to update a previously created license for a legal entity

Key points

1. Only authenticated and authorized user with an appropriate scope can update licenses.

2. The license can be updated for PRIMARY_CARE, EMERGENCY, OUTPATIENT, or PHARMACY legal entity.

3. The license can be updated for legal entities in ACTIVE or SUSPENDED statuses.

4. Only an additional license can be updated with this WS.

5. The additional license can be updated for legal entities with an active primary license.

Logic

1. Check if any attribute has changed comparing request and licenses table data (PRM DB). If any, then:

   1. Update license data according to received request in licenses table (PRM DB)

   2. Set updated_at = now()

   3. Set updated_by = user_id.

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

...

Key

...

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

...

{
  "type": "MSP",
  "license_number": "fd123443",
  "issued_by": "Кваліфікацйна комісія",
  "issued_date": "2022-02-28",
  "expiry_date": "2026-02-28",
  "active_from_date": "2022-02-28",
  "what_licensed": "реалізація наркотичних засобів",
  "order_no": "ВА43234",
  "is_primary": false
}Headers

Headers

Headers

Request data validation

Authorize

• Verify the validity of access token

  • in case of error - return 401 (“Invalid access token”) in case of validation fails

• Verify that token is not expired

  • in case of error - return 401 (“Invalid access token”)

• Check user scopes in order to perform this action (scope = 'license:write')

  • return 403 (“Your scope does not allow to access this resource. Missing allowances: license:write”) in case of invalid scope(s)

Validate request

• Validate request using JSON schema

  • in case of error - return 422

Validate legal entity

• Extract legal entity id from access token. Check that legal entity is in ‘ACTIVE’ or ‘SUSPENDED’ status

  • in case of error - return 422 (“Legal entity must be in active or suspended status”)

Validate license

• Check that updated license exists in database

  • in case of error - return 404 (“License was not found”)

• Check that updated license has is_primary=false flag

  • in case of error - return 409 (“Only additional license can be updated”)

• Check that additional license flag was passed in request ($.is_primary = false)

  • in case of error - return 422 (“Additional license can not be changed to primary”)

• Check that updated license belongs to legal entity from access token

  • in case of error - return 409 (“License doesn't correspond to your legal entity")

• Check that license type in request equals updated license type

  • in case of error - return 409 (“License type can not be updated”)

• Check that legal entity has active primary license (request: select id from licenses where is_active=true and is_primary=true and legal_entity_id=$.legal_entity.id and (expiry_date >= current_date() or expiry_date is null); returns at least one value returns at least one value)

  • in case of error - return 404 (“No active primary license found for legal entity”)

Validate license dates

• Check that $.issued_date is not greater than $.active_from_date

  • in case of error - return 422 (“License can not be issued later than active from date”)

• Check that $.active_from_date is not greater than $.expiry_date

  • in case of error - return 422 (“License can not have active from date later than expiration date”)

• Check that $.expiry_date is not lesser than current_date

  • in case of error - return 409 (“License is expired”)

Processing

N/A

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "type": "MSP",
    "license_number": "fd123443",
    "issued_by": "Кваліфікацйна комісія",
    "issued_date": "2022-02-28",
    "expiry_date": "2026-02-28",
    "active_from_date": "2022-02-28",
    "what_licensed": "реалізація наркотичних засобів",
    "order_no": "ВА43234",
    "legal_entity_id": "28d9c1be-08f0-403b-aa76-bff228c9904f",
    "is_primary": true
  }
}HTTP status codes

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

...

Post-processing processes

N/A

Technical modules where the method is used

...