-
Notifications
You must be signed in to change notification settings - Fork 0
Requirements Functional Profile
Information associated with a Job Seeker's profile, ? indicates that that attribute is optional: Profile Object -
{
firstname?: STRING,
lastname?: STRING,
dob?: DATE,
skills?: [ SKILL ],
career?: [ { jobTitle: STRING, startDate: DATE, endDate: DATE, organization: ORGANIZATION } ],
education?: [ { degree: STRING, major: STRING, gradDate: DATE, organization: ORGANIZATION } ]
}
This allows the job seeker to know what information is associated with them.
Only Job Seekers can see information this way.
Prerequirement: A Job Seeker is signed in.
- The user clicks the "PROFILE" button in the navigation bar.
Postrequirement: The user will see the information associated with their profile.
No other branches.
/profile - GET
Input: None
Possible Responses:
-
200: There is a valid logged in user.
- Returned Information: PROFILE
-
400: There is no logged in user or the user type associated with the current login is invalid.
- Error Message: TBW
@Backend
None
This allows the job seeker to add in additional information about themselves that is not included in the base sign up experience or alter information associated with themselves in case it was entered incorrectly or has changed.
Only Job Seekers can add information this way.
Prerequirement: A Job Seeker is signed in and is on their profile page.
- User clicks the edit button associated with their overall profile information.
- User adds/edits whatever information they would like.
- User clicks Save.
Postrequirement: The user will see the information that they have added/edited correctly displayed.
User doesn't input all information
- In step 3 instead of clicking save the user clicks the edit button again, nothing will be saved and the original values will be shown.
/profile - POST
Input: { "firstname": STRING, "lastname": STRING, "dob": DATE }
TBW - Possible Responses:
-
Response code number: What that code means
- Returned information/Error Response: either what would be sent in the data of a valid response or what the error message would be
Note: Any other notes such as if a input or output could only be a set list of results or any other information that is important but not specified above.
dob:
- If it exists it must be a valid DATE
This allows the job seeker to add careers that they have had to the information associated with them.
Only Job Seekers can add careers this way.
Prerequirement: A Job Seeker is signed in and is on their profile page.
- User clicks the Add Career button.
- User fills out the job title, start date, end date, and organization.
- User clicks the Save button.
Postrequirement: The user will see the information that they have added displayed.
User inputs invalid or incomplete information
- After the user clicks save it would not save the information and would indicate the incorrect/incomplete information.
User cancels addition
- Instead of clicking Save the user would close the dialogue, and nothing would be saved.
/profile/career - POST
Input: { jobTitle: STRING, endDate: DATE, startDate: DATE, organization: STRING }
TBW - Possible Responses:
-
Response code number: What that code means
- Returned information/Error Response: either what would be sent in the data of a valid response or what the error message would be
Note: Any other notes such as if a input or output could only be a set list of results or any other information that is important but not specified above.
endDate/startDate:
- Must be valid dates
- endDate must always be after startDate
This allows the job seeker to edit careers that they have had in case it was entered incorrectly or has changed.
Only Job Seekers can edit careers this way.
Prerequirement: A Job Seeker is signed in and is on their profile page.
- User clicks the edit button for the Careers section
- User clicks the edit button for the individual career they want to edit
- User changes whatever information they would like to change
- User clicks the Update Career button
Postrequirement: The user will see the information that they have changed accurately displayed.
User inputs invalid or incomplete information
- After the user clicks Update Career it would not save the information and would indicate the incorrect/incomplete information.
User cancels addition
- Instead of clicking Update Career the user would click either the Career specific or overall Careers edit button, and nothing would be saved.
/profile/career - PATCH
Input: { id: STRING, jobTitle: STRING, endDate: DATE, startDate: DATE, organization: STRING }
TBW - Possible Responses:
-
Response code number: What that code means
- Returned information/Error Response: either what would be sent in the data of a valid response or what the error message would be
Note: Any other notes such as if a input or output could only be a set list of results or any other information that is important but not specified above.
endDate/startDate:
- Must be valid dates
- endDate must always be after startDate
This allows the job seeker to remove careers that they would like to.
Only Job Seekers can delete careers this way.
Prerequirement: A Job Seeker is signed in and is on their profile page.
- User clicks the edit button for the Careers section
- User clicks the edit button for the individual career they want to edit
- User clicks the delete button.
Postrequirement: The user will not see the deleted career anymore.
None
/profile/career - DELETE
Input: { "id": STRING }
TBW - Possible Responses:
-
Response code number: What that code means
- Returned information/Error Response: either what would be sent in the data of a valid response or what the error message would be
Note: Any other notes such as if a input or output could only be a set list of results or any other information that is important but not specified above.
Career ID:
- Must be a valid id of a career associated with that user.
This allows the job seeker to add education that they have had to the information associated with them.
Only Job Seekers can add education this way.
Prerequirement: A Job Seeker is signed in and is on their profile page.
- TBW
Postrequirement: The user will see the information that they have added displayed.
User inputs invalid information
- TBW
User doesn't input all information
- TBW
/profile/education - POST
Input: { "degree": STRING, "gradDate": DATE, "major": STRING, "organization": STRING } (TBD, organization is STRING or ORGANIZATION?)
TBW - Possible Responses:
-
Response code number: What that code means
- Returned information/Error Response: either what would be sent in the data of a valid response or what the error message would be
Note: Any other notes such as if a input or output could only be a set list of results or any other information that is important but not specified above.
TBW - Input label:
- Requirement 1
This allows the job seeker to edit education that they have had in case it was entered incorrectly or has changed.
Only Job Seekers can edit education this way.
Prerequirement: A Job Seeker is signed in and is on their profile page.
- TBW
Postrequirement: The user will see the information that they have added displayed.
User inputs invalid information
- TBW
User doesn't input all information
- TBW
/profile/education - PATCH
Input: { "id": STRING, "education": {"degree": STRING, "gradDate": DATE, "major": STRING, "organization": STRING } } (TBD, organization is STRING or ORGANIZATION?)
TBW - Possible Responses:
-
Response code number: What that code means
- Returned information/Error Response: either what would be sent in the data of a valid response or what the error message would be
Note: Any other notes such as if a input or output could only be a set list of results or any other information that is important but not specified above.
TBW - Input label:
- Requirement 1
This allows the job seeker to remove education that they would like to.
Only Job Seekers can delete education this way.
Prerequirement: A Job Seeker is signed in and is on their profile page.
- TBW
Postrequirement: The user will not see the deleted education anymore.
User inputs invalid information
- TBW
User doesn't input all information
- TBW
WRONG /profile/education - DELETE
Input: { "id": STRING }
TBW - Possible Responses:
-
Response code number: What that code means
- Returned information/Error Response: either what would be sent in the data of a valid response or what the error message would be
Note: Any other notes such as if a input or output could only be a set list of results or any other information that is important but not specified above.
TBW - Input label:
- Requirement 1
So job seekers can add skills that they have to their profile.
Only Job Seekers can do this.
Prerequirement: The user is logged in and on their profile page
Postrequirement: The user can see that the indicated skill is now added to their profile.
Branch requirement/reason for it being something different
- What would happen differently
/profile/skills - POST
Input: { skills: [{ _id: STRING }] }
Possible Responses:
-
Response code 200: Successfully added skill(s)
- Returned information: None
-
Response code 400: Failed to add skill(s)
- Returned information: "Failed to add skill: {skill_id}, aborting."
Note: Any other notes such as if a input or output could only be a set list of results or any other information that is important but not specified above.
Skills:
- Must be a valid already existing skill
- Requirements Gathering
- Templates
- Functional Requirements
- Non-Functional Requirements