Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Page Properties
idAPI_Specification

Link

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/device-requests/resend-sms-on-device-request/resend-sms-on-device-request

Посилання на Apiary або Swagger

Resource

/api/patients/{{patient_id}}/device_requests/{{device_request_id}}/actions/resend

Посилання на ресурс, наприклад: /api/persons/create

Scope

device_request:resend

Scope для доступу

Components

Devices

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

PATCHGET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Public

Потрібно зазначити тип методу за ступенем доступності

Logic

API paragraph not found

Input parameters

Input parameter

Values

Type

Description

Example

patient_id

String

Unique patient identifier

7075e0e2-6b57-47fd-aff7-324806efa7e5

device_request_id

String

Unique device request identifier

aff00bf6-68bf-4b49-b66d-f031d48922b3

Request structure

API paragraph not found

...

  1. Get person's authentication_method of MPI

  2. If authentication_method == OTP:

    1. Generate text SMS with template TEMPLATE_SMS_FOR_CREATE_DEVICE_REQUEST.

  3. Call SMS timeout procedure to check if resending is allowed using:
    - DR_MAX_ATTEMPTS_COUNT as MAX_ATTEMPTS_COUNT
    - DR_SEND_TIMEOUT as SEND_TIMEOUT
    - "device_request" as entity_name
    - device_request_id as entity_id

    in case of error - return 429 ("Sending SMS timeout. Try later. Next attempt will be available at <attempts.oldest.value + SEND_TIMEOUT>")

  4. Send SMS to a person

...