View Submitted applications and their current status

[datajohnson]

Work in progress:

• main...issue-2/view-submitted-applications-and-their-current-status
• icefoganalytics/sfa-client@test...icefoganalytics:sfa-client:student-financial-aid--issues-2/view-submitted-applications-and-their-current-status

Context

Right now the portal is only displaying items from the application_draft table, but we need to surface data from the application table as well as assessments and other related things.

The API was returning that information previously, but it's been commented out.

We need a landing page for student applications that has details (non-editable), documents related to the application, letters related to the application, funding requests, etc. formatted similarly to the draft screens. An application dashboard of sorts.

@datajohnson will do the screen design and @klondikemarlen can do the wiring and API work.

Expected Endpoints and Data Formats

See https://guides.rubyonrails.org/routing.html#crud-verbs-and-actions for a stable example of route naming conventions.

• /api/portal/students/:studentId/applications
  • list format (few fields)
• /api/portal/students/:studentId/applications/:application-id
  • item format (many fields)
• /api/portal/students/:studentId/draft-applications
  • list format (few fields)
• /api/portal/students/:studentId/draft-applications/:draft-application-id
  • item format (many fields)

TODO: it might also be worth making flat URL such as

• /api/portal/applications/:application-id
  TODO: application and draft-application formats should be identical, except for a "type"??? column.

example of list format

{
  "data": [
    {
      "id": 6,
      "student_id": 124479,
      "academic_year_id": 2023,
      "create_date": "2023-07-28T19:38:41.000Z",
      "update_date": "2023-07-28T20:16:15.000Z",
      "is_active": true,
      "submit_date": "2023-07-28T20:16:15.000Z",
      "status": "Submitted",
      "description": "This application was created on July 28, 2023 and last saved 3 days ago."
    }
  ]
}

example of item format

{
  "terms_agree": true,
  "program_details": {
    "program_duration": "",
    "program_name": "",
    "start_date": "",
    "institution": {},
    "year_entering": "1",
    "start_date_of_classes": "2023-08-02T00:00:00.000Z",
    "institution_id": 2392,
    "study_area": 618,
    "program": 3,
    "attendance": "Full Time",
    "duration_of_program": "2",
    "end_date_of_classes": "2024-02-29T20:10:00.000Z"
  },
  "funding_sources": {
    "sources": ["Yukon Grant"],
    "csfa_amounts": "Full amount loans and grants"
  },
  "personal_details": {
    "first_name": "Marlen",
    "middle_name": null,
    "last_name": "Brunner",
    "home_email": "klondikemarlen@gmail.com",
    "home_phone": "12342134123",
    "birth_date": "2023-07-28T00:00:00.000Z",
    "sin": "******868",
    "category": 9
  },
  "addresses": {
    "home_address1": {
      "first": "asdfsdf",
      "city": 1,
      "region": 3,
      "postal": "Y1A OR1"
    },
    "home_address2": {},
    "primary": "Permanent",
    "home_address1_id": -1,
    "home_address2_id": -1
  },
  "statistical": {
    "language": "French",
    "gender": "Male",
    "disability": "Permanent",
    "marital_status": 1,
    "citizenship": 2
  },
  "consent": { "consents": [], "allow_others": false },
  "residency": {
    "residency_history": [
      {
        "start": "2021/05",
        "end": "2023/06",
        "city": 844,
        "province": 3,
        "country": 1,
        "in_school": 1
      }
    ],
    "has_traveled": 1,
    "last_return_date": "2023/08"
  },
  "education": {
    "education_history": [{ "left_high_school": "2023/02", "school": 310 }]
  },
  "other_funding": {},
  "student_dependants": { "dependants": [] },
  "csfa_accomodation": {},
  "csfa_income": { "incomes": [] },
  "csfa_expenses": { "expenses": [] },
  "parents": {},
  "parent_dependants": {},
  "spouse": {},
  "documents": {}
}

Data Flow Modeling

How a Draft becomes an Application

NOTE: Students can't edit a submitted application.