PAE-000: add PRN data model along with the api-definition for external PRN management (RPD tactical endpoints) #13
Conversation
…l PRN management (RPD tactical endpoints)
nijk
force-pushed
the
PAE-000-prn-modelling
branch
from
cc95782 to
d0e1a2e
Compare
|
| USER-SUMMARY updatedBy | ||
| bool isExport | ||
| bool isDecemberWaste | ||
| string prnNumber |
There was a problem hiding this comment.
is it worth considering using mongo id of the document as prnNumber instead of separate field?
I think it has to be in specific format and that's why modelled as separate field. Also does it has to be unique?
There was a problem hiding this comment.
I think it does have a specific format but I don't know much about it. We should get together with Fran to discuss this and define it fully here
| ObjectId _id PK | ||
| ObjectId organisationId FK | ||
| string name | ||
| string position |
There was a problem hiding this comment.
Organisation schema has a field called job or title for user details. If position represents same information better to be consistent.
There was a problem hiding this comment.
Good shout, let's take a look together and agree what consistent looks like
| schema: | ||
| type: string | ||
| format: uuid | ||
| example: 123e4567-e89b-12d3-a456-426614174000 |
There was a problem hiding this comment.
Unless I misunderstood all id's are meant to be mongo one's not UUID?
There was a problem hiding this comment.
correct, I thought Fran had updated these. I will ask her
There was a problem hiding this comment.
Good spot - I'd updated the id's in the Entities but missed the parameters - I'll update
| description: Timestamp when the PRN or PERN was cancelled | ||
| example: 2024-12-01T11:00:00Z | ||
|
|
||
| Address: |
There was a problem hiding this comment.
Just for info, the site in accreditation has only line1 and postcode. The registration object will have full site address
There was a problem hiding this comment.
This will be shown on the PRN for a producers POV - I'll check if line1 & postcode is sufficient
| items: | ||
| type: string | ||
| enum: | ||
| - awaiting_acceptance |
There was a problem hiding this comment.
Is it intentional not to allow querying by all statuses in schema further down?
- awaiting_authorisation
- awaiting_acceptance
- accepted
- awaiting_cancellation
- cancelled
- rejected
There was a problem hiding this comment.
I believe it is because the consumer (RPD) only needs the two statuses. Fran to confirm
There was a problem hiding this comment.
Yes was based on the RPD requirements
Ticket: PAE-000
Description
Define PRN data model via Entity Relationship Diagram and host an API definition for external consumption of PRN data in our system
Please see the Pull Requests standards.