Introduce Portal API (Citizen API)

[StephenOTT]

Introduction of highly refined and opinionated Portal API for use by Front-End applications that are used by Individuals/Organizations. (Non-Admin/non-gov users). These endpoints are in addition to the current API.

• [ ] User Profile / Persona(s)
• [ ] Cases
• [ ] Records
• [ ] Service Directory
• [ ] Notifications Directory
• [ ] Topic Subscriptions
• [ ] Messages

[StephenOTT]

Proposed Endpoints for v1

GET        cases
GET        cases/:caseid
GET        cases/:caseid/records
GET        cases/:caseid/records/:recordid
GET        cases/:caseid/records/:recordid/attachments

GET         cases/:caseid/statuses
GET         cases/:caseid/statuses/:statusid

GET        assets
GET        assets/:assetid

GET     services
GET     services/:serviceid
GET     services/:serviceid/status
POST    services/:serviceid/activation
POST    services/:serviceid/submission

GET         dashboards
GET         dashboards/:dashboardid
GET         dashboards/:dashboardid/widgets
GET         dashboards/:dashboardid/widgets/:widgetid

GET         personas
GET         personas/:personaid
PATCH       personas/:personaid
PUT         personas/:personaid

GET         messages
GET         messages/:messageid
POST        messages/:messageid/acknowledgement

GET          topics
GET          topics/:topicid
GET          topics/:topicid/subscriptions
POST         topics/:topicid/subscriptions
PATCH        topics/:topicid/subscriptions/:subscriptionid
PUT          topics/:topicid/subscriptions/:subscriptionid

POST services/:serviceid/activation Explanation:

• Creates a db row that allows a Submission. A Submission Fulfills the Activation: The Activation stores the following information which will be used to validate if a submission can be accepted before it is submitted to the Form system (such as Formio):
  1. Activation Key
  2. Type (The type is used to store the "destination" system such a Formio vs a symfony Form)
  3. System FormKey (such as the formio form key)

formio.dev/

The Type is the system to where the data is being routed to.
Should likely also store the Service ID that was used when the Activation was created.

POST services/:serviceid/submission Explanation:

• Type + Form Data + Activation Key. A Submission cannot be made without a key

[StephenOTT]

Addtional Endpoints to be considered:

1. Register User
2. Reset Password / Forgot Password

@mario-digitalstate

[StephenOTT]

Need to add additional Endpoints for "Communications" / Common Alerts.

[StephenOTT]

GET         individuals
GET         individuals/:individualid
GET         individuals/:individualid/personas
GET         individuals/:individualid/personas/:personasid

[StephenOTT]

Notes: Activation: Id Activation Key Service id Userid Anonymousid Exipiration datetime Save for later object Json