Suspend a Registration
- Dominant language
- Python
- Stars
- 2
- Forks
- 22
- Avg merge
- 2d 35m
- Merged PRs (30d)
- 11
Description
## User Stories
As an Examiner
I want to suspend a previously approved Registration
So that the Registration is no longer Active.
As an Examiner
I want to be challenged with a Confirmation Modal
So that I can confirm that I wish to suspend the Registration.
As an Examiner
I want to be able to compose a short "Email to Completing Party" message
So that this text can be incorporated into the suspension notification email sent to the Applicant.
As an Examiner
I want an Event to the added to the Registration's History log when it is suspended
So that I can view the history of changes made to the Registration.
As an Examiner
I want to be shown a "Suspended" indicator when viewing the Registration details on the Examiner dashboard after the Registration has been suspended
So that I can confirm that the Registration is suspended.
As an Applicant
I want to receive an email when my previously approved Registration has been suspended
So that I will know that I must cease all short-term rental activities.
As an Applicant
I want to be shown a "Suspended" indicator when viewing the Registration details on the Applicant dashboard after the Registration has been suspended
So that I can confirm that the Registration is suspended.
As an Applicant
I want the ability to upload additional documents to the "Supporting Documents" section of my Registration
So that I can support my case for Registration reinstatement.
## User Experience
[Before Suspending, Examiner Dashboard](https://www.figma.com/design/a4H3s0ebAxwv8ZniyNAt4g/STRR-Host-Registration---Redesign?node-id=3487-51765&t=q8ikbLbOJYgE8Bq2-1)
## Additional Details
- An Examiner can only suspend a Registration that is active and not currently subject to an NOC.
- A Registration that has been cancelled or has expired cannot be suspended.
- If a Registration expires while it is suspended, the Registration continues to be suspended even if the Registration is renewed.
- An Examiner may edit a suspended Registration because the underlying approval is still valid.
- A Property for which the Registration has been suspended cannot be used for short-term rentals.
## Acceptance Criteria
- [ ] **Scenario: Suspend a previously approved Registration**
- Given a Registration has been previously approved
- When an Examiner clicks on "Suspend Registration"
- Then the Registration should be suspended and no longer active
- [ ] **Scenario: Confirmation Modal challenges the user**
- Given an Examiner is about to suspend a Registration
- When they are presented with a Confirmation Modal
- Then the Examiner must click "Yes, Suspend" to confirm their decision before suspending the Registration
- [ ] **Scenario: Compose a short "Email to Completing Party"**
- Given an Examiner is suspending a Registration
- When the Examiner composes a short message for the Applicant in the "Email to Completing Party" section
- Then this text should be incorporated into the suspension notification email
- [ ] **Scenario: Add an Event to the Registration's History log**
- Given a Registration is suspended by an Examiner
- When the suspension occurs
- Then an Event should be added to the Registration's History log
- [ ] **Scenario: Show "Suspended" indicator on Examiner dashboard**
- Given a Registration has been suspended
- When viewed by an Examiner on their dashboard
- Then a "Suspended" indicator should be shown
- [ ] **Scenario: Send suspension notification email to Applicant**
- Given a Registration is suspended by an Examiner
- When the suspension occurs
- Then a suspension notification email incorporating the short message composed by the Examiner should be sent to the Applicant
- [ ] **Scenario: Show "Suspended" indicator on Applicant dashboard**
- Given a Registration has been suspended
- When viewed by an Applicant on their dashboard
- Then a "Suspended" indicator should be shown
- [ ] **Scenario: Allow uploading additional documents for reinstatement**
- Given a suspended Registration
- When the Applicant wants to support their case for Registration reinstatement
- Then the Applicant should have the ability to upload additional documents in the "Supporting Documents" section
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.