ЕСОЗ - публічна документація

RC__Resend SMS on Device request

Owned by Oleksandr Zhuk (SoE eHealth) (Unlicensed)
Last updated: Nov 11, 2024
2 min read

Purpose

This WS is designed to resend sms with OTP-code to the person’s verified phone on device request in case OTP wasn’t delivered in first time.

Key points

  1. Only authenticated and authorized user with appropriate scope can resend SMS on Device request.

  2. SMS with OTP-code can be resend only to person with verification_type = OTP.

  3. SMS with OTP-code can be resend only for Device request in active status

 

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

GET

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

Sync/Async

Sync

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

Public/Private/Internal

Public

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

 

Logic

API paragraph not found

 

Input parameters

Input parameter

Values

Type

Description

Example

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

 

Authorize

  1. Verify the validity of access token

    1. in case of error - return 401 (“Invalid access token”) in case of validation fails

  2. Verify that token is not expired

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

  3. Check user scopes in order to perform this action (scope = 'device_request:resend')

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

 

Headers

  • Content-Type:application/json

  • Authorization:Bearer d368a4b0-4a0e-457a-b267-32359fa6288f

 

Request data validation

Validations

  1. Check if device request with device_request_id from request is exist

    1. in case of error - return 404 (“Not found”) in case of validation fails

  2. Validate person

    1. Check if person with patient_id from request is exist

      1. in case of error - return 404 (“Not found”) in case of validation fails

    2. Check if person with patient_id from request is not preperson

      1. in case of validation fails skip all steps below

  3. Validate legal entity

    1. Check that legal_entity_type is included in chart variables ME_ALLOWED_TRANSACTIONS_LE_TYPES config parameter

      1. in case of error return 409 "Action is not allowed for the legal entity"

    2. Check that legal_entity has status = active

      1. in case of error return 409 "Action is not allowed for the legal entity" 

  4. Validate device_request

    1. Check that status = ‘active'

      1. in case of error - return 409 error ('You can not resend SMS for device request in status %status%')

 

Processing

  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 [Transferred] 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

 

Response structure

See on Apiary

Example:

{ "data": { "status": "pending", "eta": "2018-08-02T10:45:16.000Z", "links": [ { "entity": "job", "href": "/Jobs/NBXk9EyErUZv1RhXgyvgg" } ] }, "meta": { "code": 202, "url": "http://example.com/resource", "type": "object", "request_id": "req-adasdoijasdojsda" } }

 

Post-processing processes

API paragraph not found

 

HTTP status codes

HTTP status code

Message

What caused the error

HTTP status code

Message

What caused the error

 202

 

 

 

 

ЕСОЗ - публічна документація