RC_Revoke Device request

Purpose

This WS is designed to revoke previously created Device request.

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:revoke')

   • return 403 (“Your scope does not allow to access this resource. Missing allowances: device_request:revoke”) 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 (“document must be signed by 1 signer but contains 0 signatures”)

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“)

4. Ensure that $.requester.identifier.value matches with user employees

   1. in case of error - return 409 ('Employees related to this party_id not in current MSP')

Validate transition

Only active device request can be revoked

1. Get current device request status

   1. Check that status in ('active')

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

For more information look at RC_Device request status modelarchived .

Validate revoked reason

1. Validate $.status_reason.code is a value from eHealth/device_request_revoke_reasons dictionary

   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 revoked

1. Render device request from DB

2. Exclude $.status_reason 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 revoked (update also updated_at, updated_by)

3. Get person's authentication_method of MPI

4. If authentication_method == OTP:

   1. Generate text SMS with template TEMPLATE_SMS_FOR_REVOKE_DEVICE_REQUEST.

5. Send SMS

6. Save internal information to corresponding DB.

7. Send StatusChangeEvent to Event Manager