Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
REST API method / Метод REST API (настанова) (
Info
Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

Info

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]DRAFT] Create license [API-005-009-003-0188]

Guideline ID

GUI-0011

Author

@Viacheslav Tybin (SoE eHealth)

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-005-009-003-0188

Microservices (namespace)

IL

Component

Legal Entities

Component ID

COM-005-009

Link на API-специфікацію

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/licenses/create-license

Resource

{{host}}/api/licenses

Scope

license:write

Protocol type

REST

Request type

POST

Sync/Async

Sync

Public/Private

Public

...

Expand
titleExample
Code Block
languagejson
{
  "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
}

...

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

...

Response structure examples

See on ApiarySee on API-specification

Expand
titleExample
Code Block
languagejson
{
  "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
  }
}

...