Properties of a REST API method document

Purpose

This WS allows to get a list of licenses 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.

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.

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

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

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

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used

...