bcgov / entity

ServiceBC Registry Team working on Legal Entities
Apache License 2.0
23 stars 57 forks source link

API Updates for Non-Residential Exemptions #17511

Closed LizGovier closed 1 week ago

LizGovier commented 8 months ago

Reason codes: BURNT, DISMANTLED, DILAPIDATED, OFFICE, STORAGE_SHED, BUNKHOUSE, OTHER

Review data validation rules:

  1. Allowed when lien exists.
  2. No location restriction data validation rules.
  3. Can register multiple non-residential exemptions

Also, update EXRE doc type description from RESCIND to CANCEL.

Run SQL script as part of deployment: -- 17511 begin release 1.8.6 ALTER TABLE mhr_notes ADD COLUMN non_residential_other VARCHAR(125) NULL; CREATE TYPE public.mhr_note_exnr_reason_type AS ENUM ('BURNT', 'DISMANTLED', 'DILAPIDATED', 'OFFICE', 'STORAGE_SHED', 'BUNKHOUSE', 'OTHER'); ALTER TABLE mhr_notes ADD COLUMN non_residential_reason mhr_note_exnr_reason_type NULL;

update mhr_document_types set document_type_desc = 'CANCEL EXEMPTION' where document_type = 'EXRE' ; -- 17511 end release 1.8.6

doug-lovett commented 1 month ago

@LizGovier below are some example outputs to review. Anything not changed in the registration report is shared with the residential exemption template.

Registration destroyed: registration-non-res-exemption-destroyed.pdf

Registration converted: registration-non-res-exemption-converted.pdf

Search: search-detail-mhr-example.pdf

doug-lovett commented 1 month ago

Test Note: staff only so possibly test with UI. Example converted reason request: POST https://bcregistry-dev.apigee.net/mhr/api/v1/exemptions/108297 { "clientReferenceId": "UT-EXEMPTION-EXNR", "attentionReference": "JAMES IRVING", "documentId": "80888008", "submittingParty": { "personName": { "first": "JOHN", "last": "SMITH" }, "address": { "street": "222 SUMMER STREET", "city": "VICTORIA", "region": "BC", "country": "CA", "postalCode": "V8W 2V8" }, "emailAddress": "jbsmith@gmail.com", "phoneNumber": "2504930122" }, "note": { "documentType": "EXNR", "remarks": "EXNR test.", "expiryDateTime": "2024-03-30T15:39:14+00:00", "destroyed": false, "nonResidentialReason": "OTHER", "nonResidentialOther": "Smokehouse" }, "nonResidential": true }

Example destroyed reason request: { "clientReferenceId": "UT-EXEMPTION-EXNR-2", "attentionReference": "JAMES IRVING", "documentId": "80888009", "submittingParty": { "personName": { "first": "JOHN", "last": "SMITH" }, "address": { "street": "222 SUMMER STREET", "city": "VICTORIA", "region": "BC", "country": "CA", "postalCode": "V8W 2V8" }, "emailAddress": "jbsmith@gmail.com", "phoneNumber": "2504930122" }, "note": { "documentType": "EXNR", "remarks": "EXNR test destroyed.", "expiryDateTime": "2024-04-04T15:39:14+00:00", "destroyed": true, "nonResidentialReason": "DILAPIDATED" }, "nonResidential": true }

Current reg notes update example: "notes": [ { "createDateTime": "2024-04-05T22:45:15+00:00", "destroyed": true, "documentDescription": "NON-RESIDENTIAL EXEMPTION", "documentId": "80888009", "documentRegistrationNumber": "00550465", "documentType": "EXNR", "effectiveDateTime": "2024-04-05T22:45:15+00:00", "expiryDateTime": "2024-04-05T06:59:59+00:00", "nonResidentialReason": "DILAPIDATED", "remarks": "EXNR test destroyed.", "status": "ACTIVE" }, { "createDateTime": "2024-04-05T22:41:45+00:00", "destroyed": false, "documentDescription": "NON-RESIDENTIAL EXEMPTION", "documentId": "80888008", "documentRegistrationNumber": "00550464", "documentType": "EXNR", "effectiveDateTime": "2024-04-05T22:41:45+00:00", "expiryDateTime": "2024-03-31T06:59:59+00:00", "nonResidentialOther": "Smokehouse", "nonResidentialReason": "OTHER", "remarks": "EXNR test.", "status": "ACTIVE" }, { "cancelledDateTime": "2024-04-03T15:37:43+00:00", "cancelledDocumentDescription": "REGISTRY CORRECTION - STAFF ERROR OR OMISSION", "cancelledDocumentRegistrationNumber": "00550416", "cancelledDocumentType": "REGC_STAFF", "createDateTime": "2024-04-03T15:36:54+00:00", "destroyed": false, "documentDescription": "RESIDENTIAL EXEMPTION", "documentId": "12383473", "documentRegistrationNumber": "00550415", "documentType": "EXRS", "effectiveDateTime": "2024-04-03T15:36:54+00:00", "remarks": "Residential Exemption remarks.", "status": "CANCELLED" }, { "createDateTime": "2024-03-20T20:58:27+00:00", "documentDescription": "TRANSPORT PERMIT - AMENDED", "documentId": "12374857", "documentRegistrationNumber": "00550290", "documentType": "AMEND_PERMIT", "expiryDateTime": "2024-04-20T06:59:59+00:00", "remarks": "", "status": "ACTIVE" }, { "createDateTime": "2024-03-20T18:59:36+00:00", "documentDescription": "TRANSPORT PERMIT", "documentId": "80888006", "documentRegistrationNumber": "00550282", "documentType": "REG_103", "expiryDateTime": "2024-04-20T06:59:59+00:00", "remarks": "", "status": "CANCELLED" } ],

saragunnarsson commented 1 month ago

Thanks @doug-lovett ! When they select other, we don't need to pull in the word "other" it can just say "Converted - Treehouse" (and same goes for when it's destroyed and other is selected). But otherwise it looks great!

image.png
doug-lovett commented 1 month ago

Thanks @saragunnarsson updated examples below, moving to RFQA.

registration-non-res-exemption-destroyed-2.pdf registration-non-res-exemption-converted-2.pdf search-detail-mhr-example-2.pdf

saragunnarsson commented 1 month ago

Awesome, thanks @doug-lovett !

chdivyareddy commented 2 weeks ago

Hey @doug-lovett , registration outputs looks good (there was new text added in the designs which might need a new ticket for it to update), But in the Search outputs, 'Declaration details reason and Date home was '{destroyed}' header text is not displayed as expected. Please take a look, thanks!

Search Output: MHR 108182 in TEST - Expected (Declaration Details: Reason for the Non-Residential Exemption: Destroyed - Dismantled, 'Date Home was Destroyed')

Current Behavior:

Screenshot 2024-05-02 at 2.28.28 PM.png

Registration output: 2024-05-02_BCMHR_Registration_108182.pdf

doug-lovett commented 1 week ago

Report data setup update example: search-detail-mhr-example.pdf

doug-lovett commented 1 week ago

Update deployed to DEV and TEST MHR API 1.8.9.

chdivyareddy commented 1 week ago

Verified in DEV & TEST!

MHR 108182: Search Output 2024-05-07_BCMHR_Search_Result_108182_13113.pdf