RC-[NEW] Mark in error Device request

Purpose

This WS is designed to mark in error previously created Device request in case it was entered in error.

Specification

Apiary

Authorization

1. Verify the validity of access token

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

2. Verify that token is not expired

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

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

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

Validations

Validate request

Return 422 with the list of validation errors in case validation fails

Validate legal entity

1. Check legal entity type: it has to be in me_allowed_transactions_le_types config parameter, has status = active and nhs_verified = true

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

Validate digital signature

1. Validate request is signed

   1. in case of error - return 400 (“Invalid signed content”)

2. Check DS is valid and not expired

3. Validate that DS belongs to the user

   1. Check that DRFO from DS and party.tax_id matches

      1. in case of error - return 422 (“Does not match the signer drfo“)

Validate transition

1. Get current device request status

   1. Check that status != “entered_in_error”

      1. in case of error - return 409 error ('Device request in status entered_in_error cannot be marked in error')

For more information look at RC-[UPD] Device request status modelarchived.

Validate status reason

1. Validate $.status_reason.code is a value from device_request_mark_in_error_reasons dictionary

   1. in case of error - return 422 ("value is not allowed in enum")

Validate status

The target status value must be submitted in the order of display in the signed content (media storage)

1. Validate $.status is entered-in-error

   1. in case of error - return 422 ("value is not allowed in enum")

Validate content

Signed content must match with device request in DB in order to be marked in error

1. Render device request from DB

2. Exclude $status from signed content

3. Compare rendered device request and signed content

   1. In case both object doesn't match - return 422 ('Signed content doesn't match with previously created device request')

Service logic

1. Save signed content to media storage

2. Update device request status to entered-in-error (update also updated_at, updated_by)

3. Get person's authentication_method of MPI

4. If authentication_method == OTP or THIRD_PERSON (with OTP),:

   1. Check if sms notifications are enabled:

      1. if device_request has a program specified

         1. check that the specified program has setting request_notification_disabled set in false or the setting is absent, else

      2. if device_request has no program specified

         1. check config parameter DEVICE_REQUESTS_SMS_ENABLED is set in true

5. Generate text SMS with template MARK_IN_ERROR_DEVICE_REQUEST_SMS_TEMPLATE and send it

6. Save internal information to corresponding DB

7. Send StatusChangeEvent to the Event Manager