bcgov / bcgov/entity

MHR API - New Endpoints To Support QS Uploaded Documents

Open
#32,420 4 comments 0 reactions 1 assignee Claimed by @doug-lovett View on GitHub
Assets
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

DRS API access to maintain documents is restricted to staff and Registries service accounts (other Registries API's).
To enable QS lawyers/notaries to add/update/remove documents when submitting registrations, update the gateway DRS API proxy to submit requests as a service account when an MHR requests is identified as originating from a qualified supplier. In addition, if no consumerDocumentId is submitted, for these requests get a QS document ID from the MHR API with a new endpoint, and use that document ID in the request submitted by the gateway proxy to the DRS API.
The following DRS endpoints are used to support QS document submissions:
- POST /doc/api/v1/documents/MHR/{documentType}
- GET /doc/api/v1/searches/MHR?consumerDocumentId={documentId}
- PUT /doc/api/v1/documents/{docServiceId}
- PATCH /doc/api/v1/documents/{docServiceId}
- DELETE /doc/api/v1/documents/{docServiceId}
- POST /doc/api/v1/pdf-conversions

Also, for MHR document ID consistency, add a new endpoint to get the next MHR QS document ID based on the user token.
MHR document ID's use different sequence generators base on the QS type:
Manufacturers and dealers start with an 8.
Lawyers and notaries start with a 1.
Create new endpoint GET /mhr/api/v1/documents/qs-document-ids to get the next MHR formatted QS lawyer/notary document ID.

MHR API spec updated:
https://okagqp-test-bcregrestricted.apigee.io/docs/mhrproxy/1/routes/mhr/api/v1/documents/qs-document-ids/get

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.