API - Amend Transport Permit API Updates and Outputs

[mstanton1]

When a Transport Permit is submitted but an error is made in the information provided, Amend Transport Permit is used to update the Transport Permit details. This can be performed by staff, or a qualified supplier.

• update existing CHANGE_LOCATION document type with AMEND_PERMIT.
• update spec to add new properties to current view of home (transport permit number, issuance date and time, transport permit expiry)
• update schema to add new properties to current view of home (transport permit number, issuance date and time, transport permit expiry)
• outputs to be created as per design
• rules for who can complete amend transport permit to be updated - refer to design

Legacy Document Type to map to: REGC
Fee: MHROT - $15.00

Developer Notes:
If a transport permit exists on the home, update the current view of the home to include:

• permitStatus
• permitRegistrationNumber
• permitDateTime
• permitExpiryDateTime

Business Rules:

• Most recent permit must be active.
• Can be amended in an exempt state if exempt because outside of BC (last registration type is a permit or a permit amendment)
• Set to exempt if currently active and new location is outside of BC.
• Qualified suppliers are limited on what location changes can be made by current location type.
• Expiry date is the original transport permit expiry date.

Database Notes:

• Original transport permit note is cancelled.
• note record document type is 103 for the amend permit registration (different from the document record document type).

[doug-lovett]

@LizGovier this ticket will track replacing CHANGE_LOCATION with AMEND_LOCATION as well the API implementation of AMEND_LOCATION. The fee code to use should be included in the ticket description, as well as the legacy document type that AMEND_LOCATION will map to. I think it is PUBA.

[LizGovier]

Thank you to whoever updated this!

@mstanton1 Will we be adding a $15 fee to this?

[mstanton1]

@LizGovier I believe that will be the case but a decision note has been sent to Sinead to review the fees and confirm the path forward. I'll update this ticket when I have her response. Note: I've also added the legacy document type to map to. I imagine this could have mapped to PUBA or REGC but would suspect there are more cases where it maps to PUBA. Do you happen to know? Or I could check with whoever gathered the requirements:)

[LizGovier]

@mstanton1 In BCOL, Amending a Transport Permit is filed as a REGC. Staff amend a permit with a PUBA. @doug-lovett I think that's what you mentioned a while ago.

[mstanton1]

@LizGovier thank you. I think this should be raised at Requirements. We won't have a way to map the new filing type back to multiple filings types so should probably touch base with staff on what they'd like to see. In theory the impact should be limited because we don't have a ledger of transactions in BCOL that clients could view, and this mapping will only be for Transport Permit amendments done in the new system that are then viewed in legacy. I'll add this to the agenda.

[doug-lovett]

Given the description, the new code will be AMEND_PERMIT, not AMEND_LOCATION.

[LizGovier]

Thank you @doug-lovett, I've updated the description of this ticket to reflect that.

[doug-lovett]

GET /mhr/api/v1/registrations/{mhrNumber}?current=true now includes new permit properties if available:
"permitDateTime": "2023-12-21T15:37:25-08:00",
"permitExpiryDateTime": "2024-01-20T09:00:00-07:53",
"permitRegistrationNumber": "00507370",
"permitStatus": "CANCELLED",

The API amend transport permit request is identical to the transport permit request but with a new amendment boolean property:

POST /mhr/api/v1/permits/107374
{
"documentId": "80888310",
"amendment": true,
"clientReferenceId": "UT-AMEND-PERMIT",
"attentionReference": "John Irving",
"landStatusConfirmation": true,
"submittingParty": {
"businessName": "ABC UT TEST COMPANY",
"address": {
"street": "222 SUMMER STREET",
"city": "VICTORIA",
"region": "BC",
"country": "CA",
"postalCode": "V8W 2V8"
},
"emailAddress": "bsmith@abc-search.com"
},
"newLocation": {
"locationType": "MH_PARK",
"parkName": "GALLAGHER LAKE VILLAGE PARK",
"pad": "114",
"address": {
"street": "8300 GALLAGHER LK FRONTAGE RD",
"city": "PARKSVILLE",
"region": "BC",
"country": "CA",
"postalCode": " "
},
"leaveProvince": false,
"taxCertificate": true,
"taxExpiryDate": "2024-01-25T08:01:00+00:00"
}
}

[doug-lovett]

@LizGovier when you are back, outputs to review:
Active:
registration-staff-amend-permit.pdf

Exempt:
registration-staff-amend-permit-exempt.pdf

[chdivyareddy]

Hey @doug-lovett , everything looks good as per the design, but just the 'Amended' badge for the New Registered Location in the outputs isn't displayed, not sure if we are leaving this for Liz to take a look before QA? Thanks!!

ACTIVE:
2023-12-28_BCMHR_Registration_107853.pdf

EXEMPT:
2023-12-28_BCMHR_Registration_107853-2.pdf

[doug-lovett]

Thanks @chdivyareddy I missed the badge. The report template update will be in the next API build. I updated the examples in my original comment above after adding the AMENDED badge.

[doug-lovett]

@chdivyareddy and the report version with the AMENDED badge is now in DEV.

[chdivyareddy]

Thanks for the update @doug-lovett !!

[chdivyareddy]

Verified in DEV!

MHR 107938
ACTIVE:
2023-12-29_BCMHR_Registration_107938.pdf

EXEMPT:
2023-12-29_BCMHR_Registration_107938-2.pdf

[LizGovier]

Hey @doug-lovett
Just a few UXA revisions. (Design for reference)

• Cover Letter - Reverse order or Transport Permit # and Doc Reg #

• Transport Permit Amended
• Add 'Transport' to Expiry Date
• Remove Breakline
• Indent (a) and (b) in section 1
• move ', or' to the end of 1. (a)

[doug-lovett]

Thanks @LizGovier below is an example report after making your latest changes.
registration-staff-amend-permit-exempt.pdf

[LizGovier]

Beautiful! Thanks @doug-lovett

[doug-lovett]

@chdivyareddy the report update is now in TEST and SANDBOX.

[chdivyareddy]

@doug-lovett Thank you!!

Verified in TEST!

ACTIVE:
2024-01-03_BCMHR_Registration_108104 (1).pdf

EXEMPT:
2024-01-03_BCMHR_Registration_108104.pdf