ScholarX Model Update to Improve the Mentor Application

Gravewalker · May 4, 2021, 4:29am

The existing scholarx model is designed to keep only two hardcoded mentor application questions. But the requirement is to get all the necessary details from a mentor right then and there in the mentor application process to make a good comprehensive profile so everything from selecting mentors for the program to mentees selecting mentors for themselves would be easier.

The Current Model

Mentor Application Wireframes

The New Model
Even though we could have just added more columns to the existing mentor model or make a secondary table to keep the mentor responses I thought of going with a different approach. This new approach will provide admins with the ability to add questions to the mentor application as they go, so the question system would be dynamic, not hardcoded. With this, the front end will be provided with an endpoint to get those application questions and render them out in the mentor application view.

akshika47 · May 5, 2021, 10:53am

Love the separation of concerns!

Gravewalker · May 5, 2021, 1:49pm

New and Updated Endpoints

Question Category, ENUM - [ MENTOR, MENTEE ]

Add Questions

Request

POST /api/admin/programs/{programId}/questions/{Question_Category} HTTP/1.1
Host: localhost:8080
Content-Type: application/json

[
    {
        "question": "What is your highest level of education?"
    },
    {
        "question": "What is your current position/job role?"
    },
    {
        "question": "What is your organisation/institute?"
    }
]

Sample Response

Status: 200 OK
[
    {
        "id": 1,
        "category": "MENTOR",
        "program": {
            "id": 2,
            "title": "test program 1",
            "headline": "scholarx test ",
            "imageUrl": "sdf",
            "landingPageUrl": "slk",
            "state": "MENTOR_APPLICATION"
        },
        "question": "What is your highest level of education?"
    },
    {
        "id": 2,
        "category": "MENTOR",
        "program": {
            "id": 2,
            "title": "test program 1",
            "headline": "scholarx test ",
            "imageUrl": "sdf",
            "landingPageUrl": "slk",
            "state": "MENTOR_APPLICATION"
        },
        "question": "What is your current position/job role?"
    },
    {
        "id": 3,
        "category": "MENTOR",
        "program": {
            "id": 2,
            "title": "test program 1",
            "headline": "scholarx test ",
            "imageUrl": "sdf",
            "landingPageUrl": "slk",
            "state": "MENTOR_APPLICATION"
        },
        "question": "What is your organisation/institute?"
    }
]

Get Questions

Request

GET /api/programs/{programId}/questions/{Question_Category} HTTP/1.1
Host: localhost:8080

Sample Response

Status: 200 OK
[
    {
        "id": 1,
        "category": "MENTOR",
        "program": {
            "id": 2,
            "title": "test program 1",
            "headline": "scholarx test ",
            "imageUrl": "sdf",
            "landingPageUrl": "slk",
            "state": "MENTOR_APPLICATION"
        },
        "question": "What is your highest level of education?"
    },
    {
        "id": 2,
        "category": "MENTOR",
        "program": {
            "id": 2,
            "title": "test program 1",
            "headline": "scholarx test ",
            "imageUrl": "sdf",
            "landingPageUrl": "slk",
            "state": "MENTOR_APPLICATION"
        },
        "question": "What is your current position/job role?"
    },
    {
        "id": 3,
        "category": "MENTOR",
        "program": {
            "id": 2,
            "title": "test program 1",
            "headline": "scholarx test ",
            "imageUrl": "sdf",
            "landingPageUrl": "slk",
            "state": "MENTOR_APPLICATION"
        },
        "question": "What is your organisation/institute?"
    }
]

Apply as a mentor

Request

POST /api/programs/{programId}/mentor HTTP/1.1
Host: localhost:8080
Content-Type: application/json

[
    {
        "question": {
            "id": 1
        },
        "response": "PhD"
    },
    {
        "question": {
            "id": 2
        },
        "response": "PhD Candidate"
    },
    {
        "question": {
            "id": 3
        },
        "response": "Monash University"
    }
]

Sample Response

Status: 200 OK
{
    "id": 3,
    "profile": {
        "id": 1,
        "uid": "3rt9kAbxZR",
        "email": "jondoe@gmail.com",
        "firstName": "Jon",
        "lastName": "Doe",
        "imageUrl": "https://media-exp1.licdn.com/dms/image/C5103AQEDtOL8DCcMnQ/profile-displayphoto-shrink_100_100/0/1574510520118?e=1625702400&v=beta&t=kXh5dC_5vmr_cZvfKWCrKchgTgA3rQXNvrWjHCkGeGs",
        "headline": null,
        "type": "DEFAULT",
        "name": "JonDoe",
        "attributes": null,
        "authorities": [
            {
                "authority": "DEFAULT"
            }
        ]
    },
    "state": "PENDING",
    "program": {
        "id": 2,
        "title": "test program 1",
        "headline": "scholarx test ",
        "imageUrl": "sdf",
        "landingPageUrl": "slk",
        "state": "MENTOR_APPLICATION"
    }
}

Get mentor responses

Request

With profileId and programId

GET /api/programs/{programId}/responses/mentor HTTP/1.1
Host: localhost:8080

With mentorId

GET /api/programs/{programId}/responses/mentor?mentorId={mentorId} HTTP/1.1
Host: localhost:8080

Sample Response

[
    {
        "id": {
            "questionId": 1,
            "mentorId": 3
        },
        "question": {
            "id": 1,
            "category": "MENTOR",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            },
            "question": "What is your highest level of education?"
        },
        "mentor": {
            "id": 3,
            "profile": {
                "id": 1,
                "uid": "3rt9kAbxZR",
                "email": "jondoe@gmail.com",
                "firstName": "Jon",
                "lastName": "Doe",
                "imageUrl": "https://media-exp1.licdn.com/dms/image/C5103AQEDtOL8DCcMnQ/profile-displayphoto-shrink_100_100/0/1574510520118?e=1625702400&v=beta&t=kXh5dC_5vmr_cZvfKWCrKchgTgA3rQXNvrWjHCkGeGs",
                "headline": null,
                "type": "DEFAULT",
                "name": "JonDoe",
                "attributes": null,
                "authorities": [
                    {
                        "authority": "DEFAULT"
                    }
                ]
            },
            "state": "PENDING",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            }
        },
        "response": "PhD"
    },
    {
        "id": {
            "questionId": 2,
            "mentorId": 3
        },
        "question": {
            "id": 2,
            "category": "MENTOR",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            },
            "question": "What is your current position/job role?"
        },
        "mentor": {
            "id": 3,
            "profile": {
                "id": 1,
                "uid": "3rt9kAbxZR",
                "email": "jondoe@gmail.com",
                "firstName": "Jon",
                "lastName": "Doe",
                "imageUrl": "https://media-exp1.licdn.com/dms/image/C5103AQEDtOL8DCcMnQ/profile-displayphoto-shrink_100_100/0/1574510520118?e=1625702400&v=beta&t=kXh5dC_5vmr_cZvfKWCrKchgTgA3rQXNvrWjHCkGeGs",
                "headline": null,
                "type": "DEFAULT",
                "name": "JonDoe",
                "attributes": null,
                "authorities": [
                    {
                        "authority": "DEFAULT"
                    }
                ]
            },
            "state": "PENDING",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            }
        },
        "response": "PhD Candidate"
    },
    {
        "id": {
            "questionId": 3,
            "mentorId": 3
        },
        "question": {
            "id": 3,
            "category": "MENTOR",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            },
            "question": "What is your organisation/institute?"
        },
        "mentor": {
            "id": 3,
            "profile": {
                "id": 1,
                "uid": "3rt9kAbxZR",
                "email": "jondoe@gmail.com",
                "firstName": "Jon",
                "lastName": "Doe",
                "imageUrl": "https://media-exp1.licdn.com/dms/image/C5103AQEDtOL8DCcMnQ/profile-displayphoto-shrink_100_100/0/1574510520118?e=1625702400&v=beta&t=kXh5dC_5vmr_cZvfKWCrKchgTgA3rQXNvrWjHCkGeGs",
                "headline": null,
                "type": "DEFAULT",
                "name": "JonDoe",
                "attributes": null,
                "authorities": [
                    {
                        "authority": "DEFAULT"
                    }
                ]
            },
            "state": "PENDING",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            }
        },
        "response": "Monash University"
    }
]

Edit Mentor Responses

Request

PUT /api/programs/{programId}/responses/mentor HTTP/1.1
Host: localhost:8080
Content-Type: application/json

[
    {
        "id": {
            "questionId": 1,
            "mentorId": 3
        },
        "response": "PhD, something else"
    },
    {
        "id": {
            "questionId": 2,
            "mentorId": 3
        },
        "response": "PhD Candidate, ML Engineer"
    },
    {
        "id": {
            "questionId": 3,
            "mentorId": 3
        },
        "response": "Monash University"
    }
]

Sample Response

[
    {
        "id": {
            "questionId": 1,
            "mentorId": 3
        },
        "question": {
            "id": 1,
            "category": "MENTOR",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            },
            "question": "What is your highest level of education?"
        },
        "mentor": {
            "id": 3,
            "profile": {
                "id": 1,
                "uid": "3rt9kAbxZR",
                "email": "jondoe@gmail.com",
                "firstName": "Jon",
                "lastName": "Doe",
                "imageUrl": "https://media-exp1.licdn.com/dms/image/C5103AQEDtOL8DCcMnQ/profile-displayphoto-shrink_100_100/0/1574510520118?e=1625702400&v=beta&t=kXh5dC_5vmr_cZvfKWCrKchgTgA3rQXNvrWjHCkGeGs",
                "headline": null,
                "type": "DEFAULT",
                "name": "JonDoe",
                "attributes": null,
                "authorities": [
                    {
                        "authority": "DEFAULT"
                    }
                ]
            },
            "state": "PENDING",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            }
        },
        "response": "PhD, something else"
    },
    {
        "id": {
            "questionId": 2,
            "mentorId": 3
        },
        "question": {
            "id": 2,
            "category": "MENTOR",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            },
            "question": "What is your current position/job role?"
        },
        "mentor": {
            "id": 3,
            "profile": {
                "id": 1,
                "uid": "3rt9kAbxZR",
                "email": "jondoe@gmail.com",
                "firstName": "Jon",
                "lastName": "Doe",
                "imageUrl": "https://media-exp1.licdn.com/dms/image/C5103AQEDtOL8DCcMnQ/profile-displayphoto-shrink_100_100/0/1574510520118?e=1625702400&v=beta&t=kXh5dC_5vmr_cZvfKWCrKchgTgA3rQXNvrWjHCkGeGs",
                "headline": null,
                "type": "DEFAULT",
                "name": "JonDoe",
                "attributes": null,
                "authorities": [
                    {
                        "authority": "DEFAULT"
                    }
                ]
            },
            "state": "PENDING",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            }
        },
        "response": "PhD Candidate, ML Engineer"
    },
    {
        "id": {
            "questionId": 3,
            "mentorId": 3
        },
        "question": {
            "id": 3,
            "category": "MENTOR",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            },
            "question": "What is your organisation/institute?"
        },
        "mentor": {
            "id": 3,
            "profile": {
                "id": 1,
                "uid": "3rt9kAbxZR",
                "email": "jondoe@gmail.com",
                "firstName": "Jon",
                "lastName": "Doe",
                "imageUrl": "https://media-exp1.licdn.com/dms/image/C5103AQEDtOL8DCcMnQ/profile-displayphoto-shrink_100_100/0/1574510520118?e=1625702400&v=beta&t=kXh5dC_5vmr_cZvfKWCrKchgTgA3rQXNvrWjHCkGeGs",
                "headline": null,
                "type": "DEFAULT",
                "name": "JonDoe",
                "attributes": null,
                "authorities": [
                    {
                        "authority": "DEFAULT"
                    }
                ]
            },
            "state": "PENDING",
            "program": {
                "id": 2,
                "title": "test program 1",
                "headline": "scholarx test ",
                "imageUrl": "sdf",
                "landingPageUrl": "slk",
                "state": "MENTOR_APPLICATION"
            }
        },
        "response": "Monash University"
    }
]

Gravewalker · May 5, 2021, 2:14pm

github.com/sef-global/scholarx

Extend models to accommodate dynamic mentor applications

sef-global:development ← Gravewalker666:development

opened 02:13PM - 05 May 21 UTC

Gravewalker666

+392 -92

## Purpose The purpose of this PR is to fix #139 ## Goals * To extend mode…ls to accommodate dynamic mentor applications ## Approach * Introduced two new models, * Question * MentorResponses * Removed attributes `application` and `prerequisites` from `mentor` with the related service methods and controllers * Added four new endpoints and update one existing to be compatible with the above new models * Add Questions * Get Questions * Apply as a mentor (Updated) * Get mentor responses * Edit Mentor Responses More Info : [SEF Hive: ScholarX Model Update to Improve the Mentor Application](https://sef.discourse.group/t/scholarx-model-update-to-improve-the-mentor-application/259?u=gravewalker) ## Checklist - [x] This PR doesn't commit any keys, passwords, tokens, usernames, or other secrets. - [x] I have read and understood the development best practices guidelines ( http://bit.ly/sef-best-practices ) - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation ## Test environment - Postman - Java Oracle 8 - Apache Maven 3.6.3 - macOS Big Sur ## Learning - https://www.baeldung.com/jpa-many-to-many - https://stackoverflow.com/questions/46740624/org-springframework-orm-jpa-jpasystemexception-could-not-set-field-value-post - https://stackoverflow.com/questions/3585034/how-to-map-a-composite-key-with-jpa-and-hibernate

Gravewalker · May 5, 2021, 2:17pm

@Neith you can take a pull from my development branch and start on your task for we have to get this reviewed properly before merging

jaye · May 5, 2021, 2:51pm

This is amazing @Gravewalker ! The thread is also well documented!
Btw, How did you overcome that JPA issue?

Seems profileID is missing here:

Gravewalker · May 5, 2021, 4:10pm

profileID can be taken from the authentication so no need to provide it explicitly

jaye · May 7, 2021, 10:43am

Oh! Cool! Didn’t noticed it

Topic		Replies	Views
Creating a view for Apply as a Mentor ScholarX	6	258	October 22, 2020
Creating Mentee API for ScholarX ScholarX	7	456	November 12, 2020
Designing Wireframes for ScholarX platform ScholarX	21	676	August 14, 2020
Adding a new program state for mentees to confirm the mentor ScholarX	7	229	December 18, 2020
Implementing the relevant views for Mentees in a program ScholarX	41	948	November 14, 2020

ScholarX Model Update to Improve the Mentor Application

New and Updated Endpoints

Related Topics