Skip to content

MHR API - New Endpoints To Support QS Uploaded Documents #32420

@doug-lovett

Description

@doug-lovett

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, the UI will submit such document requests to the MHR API instead of the DRS API. The MHR API will then submit DRS API requests on behalf of the QS with service account credentials.
The following new MHR endpoints will support QS documents:

  • POST /mhr/api/v1/drs-documents/{documentType} maps to DRS /doc/api/v1/documents/MHR/{documentType}
  • GET /mhr/api/v1/drs-documents/{documentId} maps to DRS /doc/api/v1/searches/MHR?consumerDocumentId={documentId}
  • PUT /mhr/api/v1/drs-documents/{docServiceId} maps to PUT /doc/api/v1/documents/{docServiceId}
  • PATCH /mhr/api/v1/drs-documents/{docServiceId} maps to PATCH /doc/api/v1/documents/{docServiceId}
  • DELETE /mhr/api/v1/drs-documents/{docServiceId} maps to DELETE /doc/api/v1/documents/{docServiceId}
  • POST /mhr/api/v1/pdf-conversions maps to /doc/api/v1/pdf-conversions
    The above are proxy pass through endpoints to the DRS API.

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/supplierID to get the next MHR formatted QS lawyer/notary document ID.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions