Mark in error Device dispense

Purpose

This WS is designed to mark in error previously created Device dispense 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_dispense:mark_in_error')

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

4. If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at > current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):

   • in case not match - return 403 ("Access denied. Party is not verified")

5. If BLOCK_DECEASED_PARTY_USERS is true, check that party is not deceased (party_verification record does not equal to: dracs_death_verification_status = VERIFIED and dracs_death_verification_reason = MANUAL_CONFIRMED):

   • in case of error - return 403 ("Access denied. Party is deceased")

Validations

Validate request

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

Validate Legal entity

1. Extract client_id from token

   Check that legal entity:

   • “type” it has to be in me_allowed_transactions_le_types config parameter

     • in case of error return 409 “Invalid LegalEntity type“

   • exists and has status = active

     • in case of error return 409 “client_id refers to legal entity that is not active”

   • check that Legal Entity (client_id) from token == $.performer_legal_entity.identifier.value of Device Dispense

     • in case of error return 409 “Device dispense belongs to another 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 user

Marking in error a Device dispense is allowed for a user if he has one of the following active and approved employee that:

• is an Employee from legal entity where Device dispense is created

  • in case of error - return 409 ("Only an employee from legal entity where device dispense is created can mark it in error")

Validate transition

1. Get current device dispense status

   1. Check that status != “entered_in_error” and status != “completed”

      1. in case of error - return 409 error ('Device dispense in status <status> cannot be marked in error')

For more information look at RС_[UPD] Device dispense status modelarchived.

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 status reason

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

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

Validate content

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

1. Render device dispense from DB

2. Exclude $status from signed content

3. Compare rendered device dispense and signed content

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

Service logic

1. Save signed content to media storage

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

3. Save internal information to corresponding DB

4. Send StatusChangeEvent to the Event Manager