Purpose
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
Key points
Only authenticated and authorized user with appropriate scope can resend SMS on Service Request.
SMS with OTP-code can be resend only to person with verification_type = OTP.
SMS with OTP-code can be resend only for Service Request in ‘ACTIVE' and program processing status ‘NEW’, ‘IN QUEUE’, ’IN_PROGRESS’.
Logic
Search for service_request by patient_id + service_request_id
Validate Legal Entity
Check status of service_request
Send SMS to the person’s verified phone
Authorization
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 = 'service_request:use')
return 403 (“Your scope does not allow to access this resource. Missing allowances: service_request:write”) in case of invalid scope(s)
Input parameters
patient_id - identifier of person
service_request_id - identifier of service_request
Validate transition
Check if service request with service_request_id from request is exist
in case of error - return 404 (“Not found”) in case of validation fails
Validate person
Check if person with patient_id from request is exist
in case of error - return 404 (“Not found”) in case of validation fails
Check if person with patient_id from request is not preperson
in case of validation fails skip all steps below
Validate legal entity
Check that legal_entity_type is included in chart variables
ME_ALLOWED_TRANSACTIONS_LE_TYPES
config parameterin case of error return 409 "Action is not allowed for the legal entity"
Check that legal_entity has status = active
in case of error return 409 "Action is not allowed for the legal entity"
Validate service_request
Check that status = ‘active' and ProgramProcessinStatus in (’new', ‘in_queue', ‘in_progress’)
in case of error - return 409 error ('You can not resend SMS for service request in status %status%')
in case of error - return 409 error ('You can not resend SMS for service request in program processing status %program_processing_status%')
Processing
Get person's authentication_method of MPI
If authentication_method == OTP - send SMS:
Generate text SMS (call Man method- templates rendering service with template
SERVICE_REQUEST_CREATE_SMS
.
Send SMS
Save internal information to corresponding DB