ЕСОЗ - публічна документація
RC_CSI-2483_Resend SMS on Device request
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.
Specification
Key points
Only authenticated and authorized user with appropriate scope can resend SMS on Device request.
SMS with OTP-code can be resend only to person with verification_type = OTP.
SMS with OTP-code can be resend only for Device request in active status
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 = 'device_request:resend')
return 403 (“Your scope does not allow to access this resource. Missing allowances: device_request:resend”) in case of invalid scope(s)
Validations
Check if device request with device_request_id from request is exist
in case of error - return 404 (“Not found”) in case of validation fails
Validate device_request
Check that status = ‘active'
in case of error - return 409 error ('You can not resend SMS for device request in status %status%')
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"
Processing
Get person's authentication_method according to logic:
If authorize_with exists in device request and is not empty, check:
Authentication method exists in person_authentication_methods table in MPI DB (with is_active=true), is active (ended_at > now() or null)
Get value of
THIRD_PERSON_CONFIDANT_PERSON_RELATIONSHIP_CHECK
config parameter, if it is set totrue
- for authentication method with type = THIRD_PERSON check that person from value is an approved confidant for a person from device request – exists active and approved confidant person relationship between person from request and confidant_person_id from authentication method value (using following logic: https://e-health-ua.atlassian.net/wiki/spaces/CSI/pages/17667883028 withperson_id
= person from request andconfidant_person_id
= value from auth method - expected:ok, :approved
response)in case any validation failed - return 409 ('Authentication method doesn't exist or is inactive')
else - get authentication_method from authorize_with
If authorize_with does not exist in device request or is empty - get default authentication_method of person from MPI using logic https://e-health-ua.atlassian.net/wiki/spaces/CSI/pages/17613029453
If authentication_method == OTP or THIRD_PERSON (with OTP)
if device_request has a program specified
Generate text SMS with template
CREATE_DEVICE_REQUEST_SMS_TEMPLATE
.enrich template with data from Device Request: request_number, verification_code
if device_request has no program specified
Generate text SMS with template
СREATE_DEVICE_REQUEST_SMS_TEMPLATE_WITHOUT_CODE
.enrich template with data from Device Request: request_number
Call [Transferred] SMS timeout procedure to check if resending is allowed using:
- DEVICE_REQUEST_MAX_ATTEMPTS_COUNT as MAX_ATTEMPTS_COUNT
- DEVICE_REQUEST_SEND_TIMEOUT as SEND_TIMEOUT
- "device_request" as entity_name
- device_request_id as entity_idin case of error - return 429 ("Sending SMS timeout. Try later. Next attempt will be available at <attempts.oldest.value + SEND_TIMEOUT>")
Check if sms notifications are enabled:
if device_request has a program specified
in case of an error check that the specified program has setting
request_notification_disabled
set in false or the setting is absentreturn an error 409 "Action is not allowed for the specified medical program"
if device_request has no program specified
check config parameter
DEVICE_REQUESTS_SMS_ENABLED
is set in trueelse return an error 409 “Action is disabled by the configuration”
Send SMS to a person
ЕСОЗ - публічна документація