Versions Compared

Key

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

Purpose

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

Specification

Page Properties

Link

https://medicaleventsmisapi.docs.apiary.io/#reference/service-requests/manage-service-requests-in-patient-context/resend-sms-on-service-request

Resource

/api/patients/{{patient_id}}/service_requests/{{service_request_id}}/actions/resend

Scope

service_request:use

Components

Service request

Microservices

API paragraph not found

Protocol type

REST

Request type

PATCH

Sync/Async

Async

Public/Private/Internal

Public

...

Request to process the request using a token in the headers

Headers

Наприклад:

  • Content-Type:application/json

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

...

Request data validation

Validate transition

  1. Check if service request with service_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 service_request

    1. Check that status = ‘active' and ProgramProcessinStatus in (’new', ‘in_queue')

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

      2. in case of error - return 409 error ('You can not resend SMS for service request in program processing status %program_processing_status%')

Processing

Service logic

  1. Send SMS to patient (if authentication_method_current == SMS)

    1. Template = SERVICE_REQUEST_CREATE_SMS

  1. Get person's authentication_method of MPI

  2. If authentication_method == OTP - send SMS:

    1. Generate text SMS (call Man method- templates rendering service with template SERVICE_REQUEST_CREATE_SMS.

  3. Send SMS

  4. Save internal information to corresponding DB

Response structure

See on Apiary

...