This application supports multiple users. Each user is a document in the database that requires a username and password.
Users must login in order to view and modify there own respective work log. Once a user is logged in, they have a 20 minute session before being logged out.
Command
curl http://localhost:5000/api/v1/login -H "Content-Type: application/json" -X POST -d '{"username": "<user>","password": "<password>"}'
User = Username for user.
Password = Password for user.
Response
Success: The response is a 200 status code. The response body is a JSON object containing a success message.
Not Logged In: When the user specified is not a valid username and/or the password specified is not valid/correct, the response is a 400 status code. The response body is a JSON object containing an error message.
A user must be created in order to use this application. The account information needed is a username and a password.
Command
curl http://localhost:5000/api/v1/user/create -H "Content-Type: application/json" -X PUT -d '{"username": "<user>","password": "<password>"}'
User = Username for user.
Password = Password for user.
Response
Success: The response is a 200 status code. The response body is a JSON object containing a success message.
User Already Exists: When the user specified is already a valid user in the database, the response is a 400 status code. The response body is a JSON object containing an error message.
User Not Created: When the user specified is not a valid username and/or the password specified is not valid, the response is a 400 status code. The response body is a JSON object containing an error message.
Users have the ability to reset their password.
Command
curl http://localhost:5000/api/v1/user/<user>/reset -H "Content-Type: application/json" -X PUT -d '{"new_password": <newpassword>, "password": <password>}'
User = Username for user.
Password = Current password for user.
NewPassword = New password for user.
Response
Success: The response is a 200 status code. The response body is a JSON object containing a success message.
Password Not Reset: When the user specified is not a valid username and/or the password specified is not valid/correct, the response is a 403 status code. The response body is a JSON object containing an error message.
A user can be deleted from the database.
Command
curl http://localhost:5000/api/v1/user/<user>?deleteuser=true -X DELETE
User = Username for user.
Response
Success: The response is a 200 status code. The response body is a JSON object containing a success message.
User Not Deleted: If the specified user is not deleted, the response is a 404 status code. The response body is a JSON object containing an error message.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.
Each user has a document in the database that stores all of their associated work log information. The data being stored is:
{
"_id": ObjectId,
"settings": {
"slack": String,
"total": {
"remote": Integer,
"vacation": Integer,
"holiday": Integer,
"sick": Integer
}
}
"years": [
{
"year": Integer,
"entries": [
{
"date": String,
"type": String,
"location": String,
"notes": String
}
]
}
]
}
Visit Entry to see more information about the entry structure. Visit Settings to see more information about the settings structure.
Command
curl http://localhost:5000/api/v1/user/<user>
User = Username for user.
Response
Success: The response is a 200 status code. The response body is a JSON object containing all of the logged information for a user.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.
Command
curl http://localhost:5000/api/v1/user/<user>?deleteall=true -X DELETE
User = Username for user.
Response
Success: The response is a 200 status code. The response body is a JSON object containing a success message.
Work Log Data Not Deleted: When there is no data to delete, the response is a 404 status code. The response body is a JSON object containing an error message.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.
Each year is a document in a years list located in each user's unique document in the database that contains the following information:
{
"year": Integer,
"entries": [
{
"date": String,
"type": String,
"location": String,
"notes": String
}
]
}
Visit Entry to see more information about the entry structure.
Command
curl http://localhost:5000/api/v1/user/<user>?year=<year>
User = Username for user.
Year = Year to view.
Response
Success: The response is a 200 status code. The response body is a JSON object containing all of the logged information about a given year.
No Year Found: When there is no document for the year specified, the response is a 404 status code. The response body is a JSON object containing an error message.
Invalid Year: When the year specified is not a valid integer year, the response is a 400 status code. The response body is a JSON object containing an error message.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.
Command
curl http://localhost:5000/api/v1/user/<user>?year=<year>&deleteyear=true' -X DELETE
User = Username for user.
Year = Year to delete.
Response
Success: The response is a 200 status code. The response body is a JSON object containing a success message.
Invalid Year: When the year specified is not a valid integer year, the response is a 400 status code. The response body is a JSON object containing an error message.
Year Data Not Deleted: When there is no year specified, the response is a 404 status code. The response body is a JSON object containing an error message.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.
An entry refers to worklog data associated with a specific day.
{
"date": String,
"type": String,
"location": String,
"notes": String
}
Date must follow the format "YYYY-MM-DD"
Type must be one of the following: * office * remote * vacation * holiday * sick
Location is only required when the Type is remote
Notes are optional notes that can be included with the entry
Command
curl http://localhost:5000/api/v1/user/<user>?date=<date>
User = Username for user.
Date = Date to view.
Response
Success: The response is a 200 status code. The response body is a JSON object containing the office information for a given year.
No Date Found: When there is no data for the date specified, the response is a 404 status code. The response body is a JSON object containing an error.
Invalid Date: When the date specified is not a valid date with the required format, the response is a 400 status code. The response body is a JSON object containing an error message.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.
Command
curl http://localhost:5000/api/v1/user/<user>?date=<date>&type=<type>&location=<location> -H "Content-Type: application/json" -X POST -d '{"notes": "<notes>"}'
User = Username for user.
Date = Date to add.
Type = Type to add.
Location = Location to add. Only required if Type is remote
Notes = Optional notes to add. If not included, content-type header and data are not required.
Response
Success: The response is a 200 status code. The response body is a JSON object containing the office information for a given year.
Invalid Date: When the date specified is not a valid date with the required format, the response is a 400 status code. The response body is a JSON object containing an error message.
Invalid Type: When the type specified is not a valid type, the response is a 400 status code. The response body is a JSON object containing an error message.
Date Data Already Exists: When the date specified is part of an existing entry in the work log, the response is a 400 status code. The response body is a JSON object containing an error message.
No Date Specified: When there is no date query parameter specified, the response is a 400 status code. The response body is a JSON object containing an error message.
No Type Specified: When there is no type query parameter specified, the response is a 400 status code. The response body is a JSON object containing an error message.
No Location Specified: When there is no location query parameter specified, the response is a 400 status code. The response body is a JSON object containing an error message.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.
Command
curl http://localhost:5000/api/v1/user/<user>?date=<date>&type=<type>&location=<location> -H "Content-Type: application/json" -X PUT -d '{"notes": "<notes>"}'
User = Username for user.
Date = Date to update.
Type = Type to update.
Location = Location to update. Only required if Type is remote
Notes = Optional notes to update. If not included, content-type header and data are not required.
Response
Success: The response is a 200 status code. The response body is a JSON object containing the office information for a given year.
Invalid Date: When the date specified is not a valid date with the required format, the response is a 400 status code. The response body is a JSON object containing an error message.
Invalid Type: When the type specified is not a valid type, the response is a 400 status code. The response body is a JSON object containing an error message.
No Date Specified: When there is no date query parameter specified, the response is a 400 status code. The response body is a JSON object containing an error message.
No Type Specified: When there is no type query parameter specified, the response is a 400 status code. The response body is a JSON object containing an error message.
No Location Specified: When there is no location query parameter specified, the response is a 400 status code. The response body is a JSON object containing an error message.
No Date Found: When there is no data for the date specified, the response is a 404 status code. The response body is a JSON object containing an error.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.
Command
curl http://localhost:5000/api/v1/user/<user>?date=<date> -X DELETE
User = Username for user.
Date = Date to delete.
Response
Success: The response is a 200 status code. The response body is a JSON object containing the office information for a given year.
Invalid Date: When the date specified is not a valid date with the required format, the response is a 400 status code. The response body is a JSON object containing an error message.
No Date Data Deleted: When there is no date query parameter specified or no data for the date specified, the response is a 404 status code. The response body is a JSON object containing an error.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.
Settings refer to the settings for a user in association with their worklog data.
{
"slack": String,
"total": {
"remote": Integer,
"vacation": Integer,
"holiday": Integer,
"sick": Integer
}
}
Slack is the URL for a slack webhook. If a valid URL is provided, when a user adds or modifies an entry, a message is sent to the Slack app associated with the webhook.
The total for remote, vacation, holiday, and sick refer to the total number of days that can be used in a year.
Command
curl http://localhost:5000/api/v1/user/<user>/settings
User = Username for user.
Response
Success: The response is a 200 status code. The response body is a JSON object containing the settings information for a user.
No Settings Found: When there is no data in the database for the user specified, the response is a 404 status code. The response body is a JSON object containing an error.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.
Command
curl http://localhost:5000/api/v1/user/<user>/settings -H "Content-Type: application/json" -X PUT -d '{"slack": <slack>, "remote": <remote>, "vacation": <vacation>, "holiday": <holiday>, "sick": <sick>}'
User = Username for user.
Slack = Slack webhook URL.
Remote = Remote total that can be used in a year.
Vacation = Vacation total that can be used in a year.
Holiday = Holiday total that can be used in a year.
Sick = Sick total that can be used in a year.
Response
Success: The response is a 200 status code. The response body is a JSON object containing the updated settings information for a user.
No Settings Specified: When there are no settings specified in the data of the request, the response is a 400 status code. The response body is a JSON object containing an error.
No Settings Found: When there is no data in the database for the user specified, the response is a 404 status code. The response body is a JSON object containing an error.
Not Logged In: When the user specified is not a valid username or the valid user is not currently logged in, the response is a 403 status code. The response body is a JSON object containing an error message.