Client Request: Step 02

[patricksan]

What?

Please, reference to file: /documentation/phases/Phase-01-school-management/01-New Client Request.pdf

This ticket is to create the Model + API from Step 02. This is related to Client Request Details

How?

• Create model Contact

  • Client can have multiples contact, so create a boolean to say if it is primary or not

• Create model Contract

  • References to Documents Table with a type Contract

• Create model Documents

  • References to Documents Table with a type General

• Create model Activity

• Create model Action

  • This could be a status in the Request table

• Create model Request Comments

• Create API to return a specific request

  • GET /client/request/125455
  • This API should return everything

Expected

• API layer should return a Dto and not the object from database
  • this is to avoid show data we don't want
  • this helps to concentrate all info in one API

[Aurrix]

As per conversation with @patricksan, we agreed:

• [x] 1. Use for id format 'REQ12345' in client requests
• [x] 2. Do not specify DB engines in SQL script
• [x] 3. Create Institution (supposed to be client)
• [x] 4. In an institution for student & staff numbers use enums
• [x] 5. One to one relation between contract and user
• [ ] 6. To create an account in nexus
• [x] 7. Contact to be named user
• [ ] 8. Fields for the user entity from Keycloack DB
• [x] 9. Categories for client request: (Premium, Limited, Demo)
• [ ] 10. Request fields licenses & academic
• [x] 11. Exclude fields mobile app & required website from request entity
• [ ] 12. Create tickets for the above in the docs repo
• [x] 13. Statuses for contract: No Sent, Sent, Received
• [x] 14. Designation: would be a string (signing person)
• [x] 15. Activity will include referencing string (indexed), short_description string (index), description (text), timestamp, user reference,
• [x] 16. Activity category will be enum (Client, Internal)
• [x] 17. Action to be only UI part, remove the entity
• [x] 18. Do not version API
• [x] 19. The client Should have one to many addresses, add primary boolean to address
• [x] 20. There should one to many between client and activities

[Aurrix]

@patricksan I've actually checked out the docs once again it seems that institution in client request page is a client entity, so I will just add missing fields if any