...

...

1. Extract client_id from token.

2. Filter active licenses:

   1. for current legal entity from token (licenses.legal_entity_id=$.client_id).

   2. by search params.

3. Render found licenses with all fields from DB.

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 ConfluenceN/A

Dictionaries

N/A

Input parameters

...

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Headers

Request data validation

Authorize

• Verify the validity of MIS client secret

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

• 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:read')

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

Processing

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

Response structure examples

...

{
  "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
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

...

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

...