by Jeremiah Cheng, Andrew Chan, Anna Zhou, Jimmy Hua
This application is intended to be used by people who need to easily figure out when other people in a group are free. This could be used for scheduling meetings, but also for any sort of group activity. Whether it be grabbing coffee, having a party or planning a company meeting, this app will provide the capability for people to easily find out when every person is free. Realistically, this will be used most by students and young adults, and potentially working professionals for planning activities. This application is useful because it allows for users to log in and save their schedule information and allows for the planning of multiple events. This has more functionality than current alternatives such as When2Meet which only has temporary meetings. It should make planning events and get-togethers even easier and much more efficient. We as developers would like to build this application as it will give us more practice in authenticating users and allowing for them to interact with other users. It should present a valuable experience in furthering our knowledge of Golang and its capabilities alongside Docker and associated Databases.
| Priority | Description |
|---|---|
| P0 | As a user, I want to be able to input my free times and see where overlap exists |
| P1 | As a user, I want to be able to be able to create a meeting and add other users |
| P2 | As a user, I want to be able to save a schedule that is tied specifically to my account |
| P3 | As a user, I want to be able to change my schedule |
| P4 | As a user, I want to be able to view updated meeting times based on my saved schedule |
| P5 | As a user, I want to be able to alter my schedule once a meeting is decided |
GET;/user/: Gets the free times, schedule, and meetings for the current user- Inputs: None
- Outputs:
application/json - Header:
- Authentication: bearer token
- Response Codes:
200:application/jsonsuccess400: UserID does not exist401: User not authenticated405: Wrong Method
PATCH;/user/: Updates free time to user's schedule- Inputs:
application/json - Outputs:
application/json - Header:
- Authentication: bearer token
- Content-Type:
application/json
- Response Codes:
201:application/jsonsuccess400: UserID does not exist405: Wrong Method415: Wrong content type
- Inputs:
GET;/meeting/{id}: Gets the free times, users, meeting description, meeting title associated with a meeting- Inputs: Meeting ID (int)
- Outputs:
application/json - Header:
- Authentication: bearer token
- Response Codes:
200:application/jsonsuccess401: User not authenticated or User doesn't belong in meeting405: Wrong Method
DELETE;/meeting/{id}: Deletes a meeting- Inputs: Meeting ID (int)
- Outputs:
text - Header:
- Authentication: bearer token
- Response Codes:
200:application/jsonsuccess400: meeting id does not exist401: User not authenticated405: Wrong Method
POST;/meeting/{id}: Adds users to a meeting- Inputs: Meeting ID, User ID
- Outputs:
text: success message - Header:
- Authentication: bearer token
- Content-Type:
application/json
- Response Codes:
201:application/jsonsuccess401: User not authenticated or User is not the creator405: Wrong Method415: Wrong content header
GET;/getuser/{id}: View information for users- Inputs: ID from URL
- Outputs:
application/json - Header:
- Authentication: bearer token
- Content-Type:
application/json
- Response Codes:
200:application/jsonsuccess405: Wrong Method415: Wrong content header
POST;/users: creates a new user- Inputs:
application/json - Outputs: User ID
- Header:
- Content-Type:
application/json
- Content-Type:
- Response Codes:
200: success405: Wrong Method415: Content header is not json
- Inputs:
POST;/sessions: Logs in existing user- Inputs:
application/json - Outputs:
text: success - Header:
- Content-Type:
application/json
- Content-Type:
- Response Codes:
200: success405: Wrong Method415: Content Header is not JSON
- Inputs:
POST;/meeting: create a new meeting- Inputs:
application/json - Outputs: Meeting ID
- Header:
- Authentication: bearer token
- Content-Type:
application/json
- Response Codes:
200: success400: Existing meeting401: User not authenticated405: Wrong Method
- Inputs:
user: represents any user in our user table
{
"UserID": "id",
"Email": "email",
"PassHash": "password",
"FirstName": "fname",
"LastName": "lname"
}
login: login credentials will be
{
"Email": "test@example.com",
"Password": "test123"
}
new user: will be sent as:
{
"Email": "test@test.com",
"Password": "password",
"PasswordConf": "password",
"FirstName": "first",
"LastName": "last"
}
meeting: will be sent as:
{
"MeetingName": "new meeting",
"MeetingDesc": "description"
}
free times will be returned as:
{
“Sunday”: [“1000”, “1030”, “1100”],
“Monday”: [“1130”, “1330”, “1600”. “1630”],
“Tuesday”: [“0100”, “0700”, “0800”, “1400”, “1430”],
“Wednesday”: [“1900”, “1930”, “2000”, “2030”],
“Thursday”:[ ],
“Friday”: [“1200”. “1230”. “1300”. “1330”],
“Saturday”: [“0900”, “0930”, “1000”, “1030”]
}
meetings will be returned as:
{
“Meeting Name”:”Info 441 party”,
“Meeting Desc”:”none”,
“CreatorID”:1,
“Members”:[2,3,5],
“Sunday”: [“1000”, “1030”],
“Monday”: [“1130”, “1600”. “1630”],
“Tuesday”: [“0100”],
“Wednesday”: [“1900”, “1930”, “2000”, “2030”],
“Thursday”:[ ],
“Friday”: [“1200”. “1230”],
“Saturday”:[ ],
}
user information will be returned as:
{
"Email": "test@example.com",
"FirstName": "Test",
"LastName": "McTest",
"Week": {
"Sunday": ["1100"],
"Monday": ["0100"],
"Tuesday": [],
"Wednesday": [],
"Thursday": ["1100"],
"Friday": [],
"Saturday": ["0930"]
}
}
getuser response:
{
“Email”: “test@test.com”,
“FirstName”: “Test”,
“LastName”: “Tester”
}
