Purpose

This WS allows to get a list of licenses list for a legal entity. Used by legal entity employees to receive full information about primary and additional licenses of legal entity.

Key points

1. This REST method is used by MIS.

2. Only authenticated and authorized user with appropriate scope can get licenses list.

Specification

...

Apiary

Logic

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.

Preconditions

API paragraph not found

Global and configurable parameters

No

Input parameters

No

Filters

Request structure

See on Apiary

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)

Search params

• id

• license_number

• type

• is_primary

Service logic

...

Extract client_id from token.

...

Filter active licenses:

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

2. by search params.

...

Headers

API paragraph not found

Validate request

API paragraph not found

Request data validation

API paragraph not found

Parameters that are used when processing the request

Configuration parameters

Access to the method is defined by the scope license:read. Permission for this scope is determined by the System administrator by configuring scopes in the context of clients and roles.

Dictionaries

API paragraph not found

Processing

API paragraph not found

Response structure

See on Apiary

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

Post-processing processes

No

HTTP status codes

Backward compatibility

API paragraph not found