...

...

Save new license in licenses table (PRM DB)

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

• LICENSE_TYPE

• LEGAL_ENTITY_<LEGAL_ENTITY_TYPE>_ADDITIONAL_LICENSE_TYPES

Input parameters

ATTRIBUTES: see on Apiary

Request structure

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

{
  "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
}

...

...

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

...

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

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

• Check that license type in request exists in LICENSE_TYPE dictionary

  • in case of error - return 422 (“value is not allowed in enum”)

• Check that license type in request exists in chart parameter LEGAL_ENTITY_<LEGAL_ENTITY_TYPE>_ADDITIONAL_LICENSE_TYPES based on legal entity type

  • in case of error - return 409 (“Legal entity type and license type mismatch")

• 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)

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

• Check that legal entity does not have license with type same as in request ($.type)

  • in case of error - return 409 (“License with type $.type is already present”) where $.type = license type from request

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

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

Response structure examples

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

Description of the REST API response structure, example

{
  "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
  }
}

...

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

...