diff --git a/research/API Documentation.md b/research/API Documentation.md index 7e5f55a..8a5aaf8 100644 --- a/research/API Documentation.md +++ b/research/API Documentation.md @@ -6,12 +6,12 @@ ___ | field | data type | metadata | | :-------------| :---------------- | :-------------------------------------------------- | | id | unsigned integer | primary key, auto-increments, generated by database | -| username | string | required | -| email | string | required | -| password | string | required | -| timezone | string | | -| earliest_time | string | | -| latest_time | string | | +| username | varchar | required | +| email | varchar | required | +| password | varchar | required | +| timezone | varchar | | +| earliest_time | varchar | | +| latest_time | varchar | | | created_at | datetime | generated by database | #### Register an account @@ -22,7 +22,7 @@ A json object for the user to register with **`username`**, **`email`**, **`pass ``` { - "username": "jean, + "username": "jean", "email": "jean@example.com", "password": "really-strong-password", "timezone": "Europe/Brussels", @@ -48,63 +48,6 @@ A json object for the registered user with `id`, `username`, `email`, `timezone` } ``` -#### Update an account -**`PUT /api/account/:id/profile`** - -##### Request -A json object for the user to register with `id` and any of `username`, `email`, `password`, `timezone`, `earliest_time`, `latest_time`. - -``` -{ - "id": 15, - "earliest_time":"08:30 AM", - "latest_time":"08:00 PM" -} -``` - -##### Response -A json object for the registered user with `id`, `username`, `email`, `timezone`, `earliest_time` and `latest_time`. - -``` -{ - "status": 200, - "data": { - "id": 1, - "username": "jean", - "email": "jean@example.com", - "timezone": "Europe/Brussels", - "earliest_time":"09:30 AM", - "latest_time":"10:00 PM" - } -} -``` - -#### Delete an account -**`DELETE /api/account/:id`** - -##### Request -A json object for the user to delete with `id`. - -``` -{ - "id": 15 -} -``` - -##### Response -A json object for the deleted user with `username` and `email`. - -``` -{ - "status": 200, - "data": { - "id": 15, - "username": "jean", - "email": "jean@example.com" - } -} -``` - #### Log in an account **`POST /api/account/login`** @@ -133,4 +76,204 @@ A json object for the registered user with `id`, `username`, `email`, `timezone` "latest_time":"10:00 PM"l } } +``` + +#### Update an account +**`PUT /api/account/:id/profile`** + +##### Request +A json object for the user to register with `id` and any of `username`, `email`, `password`, `timezone`, `earliest_time`, `latest_time`. + +``` +{ + "id": 15, + "earliest_time": "08:30 AM", + "latest_time": "08:00 PM" +} +``` + +##### Response +A json object for the registered user with `id`, `username`, `email`, `timezone`, `earliest_time` and `latest_time`. + +``` +{ + "status": 200, + "data": { + "id": 1, + "username": "jean", + "email": "jean@example.com", + "timezone": "Europe/Brussels", + "earliest_time": "09:30 AM", + "latest_time": "10:00 PM" + } +} +``` + +#### Delete an account +**`DELETE /api/account/:id`** + +##### Request +A json object for the user to delete with `id`. + +``` +{ + "id": 15 +} +``` + +##### Response +A json object for the deleted user with `username` and `email`. + +``` +{ + "status": 200, + "data": { + "id": 15, + "username": "jean", + "email": "jean@example.com" + } +} +``` + +### **Meetings** | `meeting` +| field | data type | metadata | +| :---------- | :-------- | :-------------------------------------------------------------------------------- | +| id | varchar | primary key, first 30 chars of `title` with words separated by `-` + 5 random int | +| title | varchar | required | +| description | varchar | | +| start_time | datetime | | +| timezone | varchar | | +| duration | int | required | +| status | boolean | required: `0` (proposed) or `1` (confirmed) | +| password | varchar | | +| created_at | datetime | generated by database | + +#### Add a meeting +**`POST /api/meeting/add`** + +##### Request +A json object for the meeting to add with **`id`**, **`title`**, `description`, `start_time`, **`duration`** and `password`. + +``` +{ + "id": "worldwide-strategy-meeting-for-11059", + "title": "Worldwide strategy meeting for growth", + "description": "Let's find the best ethical growth hacking technics together. Yeah, fun.", + "duration": 90, + "password": "generic-password" +} +``` + +##### Response +A json object for the added meeting with `id`, `title`, `description`, `start_time`, `duration`, `status` and `password`. + +``` +{ + "status": 201, + "data": { + "id": "worldwide-strategy-meeting-for-11059", + "title": "Worldwide strategy meeting for growth", + "description": "Let's find the best ethical growth hacking technics together. Yeah, fun.", + "duration": 90, + "status": 0 + } +} +``` + +#### Get a list of meetings for an account +**`GET /api/meeting/account/:account_id`** + +##### Request +A json object with an `account_id`. + +``` +{ + "id": 5 +} +``` + +##### Response +A json object for the specified account with an array of `meeting`. + +``` +{ + "status": 200, + "data": [ + { + "id": "worldwide-strategy-meeting-for-11059", + "title": "Worldwide strategy meeting for growth", + "description": "Let's find the best ethical growth hacking technics together. Yeah, fun.", + "start_time": 2022-02-16 20:00:00, + "timezone": "Europe/Brussels", + "duration": 60, + "status": 1 + }, + { + "id": "follow-up-with-tech-team-21850", + "title": "Follow up with tech team", + "duration": 120, + "status": 0 + } + ] +} +``` + +#### Update a meeting +**`PUT /api/meeting/:id`** + +##### Request +A json object for the meeting to update with `id`, `acount_id` and any of `title`, `description`, `start_time`, `timezone`, `duration`, `status` and `password`. + +``` +{ + "id": "worldwide-strategy-meeting-for-11059", + "account_id": 5, + "start_time": 2022-02-16 20:00:00, + "timezone": "Europe/Brussels", + "status": 1 +} +``` + +##### Response +A json object for the updated meeting with `id`, `title`, `description`, `start_time`, `timezone`, `duration` and `status`. + +``` +{ + "status": 200, + "data": { + "id": "worldwide-strategy-meeting-for-11059", + "title": "Worldwide strategy meeting for growth", + "description": "Let's find the best ethical growth hacking technics together. Yeah, fun.", + "start_time": 2022-02-16 20:00:00, + "timezone": "Europe/Brussels", + "duration: 90, + "status": 1 + } +} +``` + +#### Delete a meeting +**`DELETE /api/account/:id`** + +##### Request +A json object for the meeting to delete with `id` and `account_id`. + +``` +{ + "id": "worldwide-strategy-meeting-for-11059", + "account_id": 5 +} +``` + +##### Response +A json object for the deleted user with `username` and `email`. + +``` +{ + "status": 200, + "data": { + "id": "worldwide-strategy-meeting-for-11059", + "title": "Worldwide strategy meeting for growth", + } +} ``` \ No newline at end of file diff --git a/research/meetingscheduler.drawio b/research/meetingscheduler.drawio index 829cf15..83804c0 100644 --- a/research/meetingscheduler.drawio +++ b/research/meetingscheduler.drawio @@ -1 +1 @@ -7V1bd6O2Fv41fswsxJ3H3DydNm3mnEzn8tQlG8VWByMX5CTur68AgUECG19AOEnWmjVGEjLsb9+095Y8Mq4XLx8juJz/TnwUjHTNfxkZNyNdtyzDZv8lLeusxTBd3jKLsJ+1gU3DA/4X8UaNt66wj+LKQEpIQPGy2jglYYimtNIGo4g8V4c9kqD6rUs4Q1LDwxQGcus37NN51urqzqb9F4Rn8/ybge1lPRM4/TmLyCrk3zfSjXH6l3UvYD4Xf9F4Dn3yXGoybkfGdUQIzT4tXq5RkBA3J9u3T+tvwd1P++Ov/4v/gX9e/fblj68X2WTjfW4p3jBCIT146vFfD7c3+v38h2WAUIu/fp9o2oWVvxtd5/REPiMvvyQRnZMZCWFwu2m9SmmGkmk1drUZc0fIkjUC1vg3onTNeQWuKGFNc7oIeC97jWj9Pbn/g5Vf/ij33bzwybOrNb/KnjV5QAH6HYTh42KyiqZoyziDsy+MZohuoZrpFPAzuUJkgdhTshsjFECKn6pPBzl/z4pxG5DYB47TPpiZQ8JMOxfMlEJmqYWsAtgGv4FDZvUE2baHfILBin/TL2zm1BiJUG6ASqj+PMcUPSxhSoJnZnSroDySkHLEAHu7q1kA45gTPqYR+VlYsWR0YXNA0X1NAhKlX2w4Y01j5ipHrC1ATyii6KVEPpnGvPfCMDkduHfAVB+3q88bWwtyCzkv2VlT60qWnDcqS81qrYUsAftIYUpvvYwiuC4NWBIc0rg08+ekocQ/uivwD7AdgQOyOTf8UDzc4SxiSrJ7R2Y4lAV3ThaTVbxbaCXJG49dTdvgK0lUW4S3SJ7uVilnGLLkeTWCZ3cmePYb9TuajVMbwWNa/gSSJ4tWjn3BH64AfPZo/DYB+xMImSUJ2f/RDMcURSPdDhhJribJpxktwDgTyQO6aPNcxZIHgBLRk2ivpX8DFspM1lpJ5bHOZYNUmpYglrbTr1jmJKjIZYxoSuY4fiaRf5wDu5dL2oVhFF1Sx1btkubiWaL5DYznEwKPJnYjfSswdKcLDcELATW6sF9i67J3JyvH0L9MQovsapqsr/BUcCpeMP1e+lzy5dnVRnklF7nuGuoKIGe+nTrPaIhalZC0aoDM247VjK7ASTpwqnNkbyopRmkmoDkCT3rCTB2rWF12fVYxikK4QLLrgxYQB3LzRheLPRQv0L8krJsKRgFGcUKKZJA8gAFU7haEgmmMZfIxJBTt1jyb6Pj9igY4RLzdh9HPe3YXpimDf9CsDvUP0AWordy8lZjWrWFaADpTP85e6idMkEyoFs8LnV+jiLR9FBG7+IwiBnHiawvKCQxLOeltl0kN7lhPusmSXP4DddOFbggzGVq/ysmQfZE3bR7zqMluDnRVsmBhDRuNWlsW1F1PrXk0ZA25jMgjDo6MnCv2hWW3Q7krbBuyaHcfFuhaYnNy7ZRY+9jI2lHEzx+zxObxlBn5VcLnGmT/FghRHM7OmuulFSDIl9/KuN4EEuH3t3BDDWC1XcyZDfnsnhwmT0xOHOoviavCnm2V+Z7TkJiqDfdp9dzXk+aVI0DQ93cp3XPKOOiqU31Aot/bKAvbUu7VJqug1iGp8buLKJP2SKIZoRSdeRbczt0KZaLhSlRGPk5M2iJ58MaVznCJbBhWlcbFglEZjb29PLxdMbYD1Up6JQXa8oBdEQ75UeqpD410rZ9ahzh0tVE2066aOZDHyvb2Gk1QnckVJurYa7TlpR/FNKiJyPsonkZ4STEJazpXEazvac4OyC0xe1n6V31CgPVRpnR212OcYW7gwrSqTODJC9N+UwP2fgvTLlID9UHYiqJzq5rOaVR1nbtVreM8DauNvtSWV+WzgtH2Vlti6QJw3H71luLS2WGtdm29Lf8dWzt7nFbRJa0Sw6ckxrgkcYwnabjRTzK/5+R0SmvewsNU5XTaclQhoeqrNJWFblRnK+UaindbeQpdpTYuLEq1AaxDbaWjf/BKf+72eTu2nM6gAmLKLWfbLIWjNE5cZGwVobZnLU5zufVg8LQbaiT6wtNVK4WvDk9H6a5YWy5VepUpc1N5gbrdFLQWA0PnmD0ztKrPYVrKt+t45+QtqNNTTtsIEABKDY8jx3tx+IQpyohB8RQvId8IezZiI7rqtgHUio2j2LoPy8d22p6S4Cg9jKSIELz7ZCfC01O6ZnLkcy/W7NWSr3qCOMAT9o+uz9o/04VNJerdM6ApdhjORojaFqhlbKxMiBoK1Ma8UmS7KA3XZ7AEwVHtaDtyxdNqmQXttc02uuuEJYutc+Ptm+QGTH3d1IflsHmyW8wzU61MxnApbZoDY3RPlyidsXltMUjNztHQrykyidAjYnSavoocly5gpju6hFm/KS5vv43qb72Krb2DrNczgqJyEAccXMUmlIPYdr9lbF5NVLB+t3qbPelNm9GbatLOX+XkSdkcPs1WrXFOWjfb4vifPTNcp9rt3rUqygXj4PymKlXkCXMcrIocU5ip61OLtJPWTm5h3QNYsHPL17Z+21O6Rf107CZudnesnrkNnNURyuriLaD9gWpKayRBzalnUxI+4mjBK+w17tk0eB2MYjAIUEBmEVwka6OSxan0lUxR64PSGjB0xmnM8xEHQWVxOx53e4AasM0Pwo6furNFQe6Q9xMCBYprk88lBApAzZE6zSdYHyGR6a17n/hrOlUjcZEHTzo98begSkkBRPzYw3fJL445ygNUxW5KQ64D7lvu5UVomlt/19u79bZjdwffnzGK7id/J7/YomsBnKAg98qzBf0ciFvSkpPtKyjZ/6xI3nERpyr4kg1w9OXLpjOf5fe88kh74KeoRPnE7Mmyuavfx5rLD5GSOGCgzkngo6j6qzLp2Xxpw1cYYTjJd+juOEq17NRwbi4xIQOYblt38EVKmVF4EwzwLGSXU8YQKUsm7IKnMLjkHQvs+0FTHISw0Y9ByqJzNg6FItN2xoKOJigQoNXsxy6OvK1EPfT9eZBdltiwHVuah7Kl6dax5R2alYLnWzjR7JYT3XdOrGRoREsGNF1mRL0ui++ap+DDtocx10XkeEQ0Z5jPlx9vS5w0GTUemt5BkUXfVswCtrj48GqQ67n+wpAzmRJMl9dfPt3/0Q6o41ObFSnqHSQDiCA5Nb/70m9RrVEXIRQwevh0w0RJux2Pb6+/tILqDTqSpvjLEW6NDe95FWDI8RsJ3Juaww++XF7dtVOeHeaXduHMIwP9S7Gkagv/TVmKChgHZcVbxfZHx4RelEXVXcGn9kRHuf1ZepJ3LjndXQfWjYO29b5edE8G7hCwPejk89eL7ekkd+dEnUMrB+Heod0hbkOQXHa5+f3hbPjmV56N2/8A \ No newline at end of file +7V1Zd6O4Ev41eUwOEvtjNvdy052eSU8vTznYKDYTjNyAs8yvvwJLNpKwkQmbk+ScPm0EyLiWr0pVpeJIP58/fYi9xewL9lF4BDX/6Ui/OILQNHWL/JeNPK9GdMOhI9M48FdjYDNwE/yH6KBGR5eBjxLuwhTjMA0W/OAERxGapNyYF8f4kb/sDof8ty68KZIGbiZeKI/+DPx0thp1oL0Z/4iC6Yx9M7Dc1ZmxN7mfxngZ0e87gvoo/1udnntsLvpDk5nn48fCkH55pJ/HGKerT/OncxRmxGVk+/np+Wd4dW99+PxX8sf75+x/37/+OF5NNtrnlvUvjFGU1p56dHtzeQGvZ79NHURa8uPXWNOOTfbb0mdGT+QT8tJDHKczPMWRF15uRs9ymqFsWo0cba65wnhBBgEZ/Bel6TOVFW+ZYjI0S+chPUt+Rvz8K7v/xGSHv4vnLp7o5KujZ3qkSAdKrwQv4wnacZ1OpdWLpyjdQSSDilJGmYLMUTJ/QHiOyFOSC2IUemnwwAumR+V7ur5uwyTygfJpH54ZQ+KZNlCeDYtlZr8s4xi24d+wWGb2xbJdT/3ghUv6TR/JzLkxElm5YVRG9cdZkKKbhZfT5JEYXZ4pdzhKKccA+XVn09BLEkr4JI3x/dqKZVevbQ5Ynz7HIY7zL9btkaYRc7Uvxx5QnKKnnTSmZ491gzoD1DsgBsNZDTxubC1gFnJWsLOG1pYu2W9Dl3bBWqUuAatpZcpvPY1j77lwwQIHUZoUZv6WDRTkBzqC/ADXESRgNedGHtYPV19EDEl3r/A0iGTFneH5eJlUK62keaORo2n783cfzdMBTzndkjXPLVE8qzXFs96G37HLOFUrHgH1NjRPVi1X5+XDAMIcq2eltwm8b0DJTEnJ/kbTIElRfAStkNDobJx9mqZrZhyI5gEo2jzQs+YB0IvqSbTX8r/hKCXTNQWtbNy53KKVhimopa11q5aMJpxeJijN6Z4kjzj2X+bADs4ltd2+XVKmngWaX3jJbIy9FxN7K305NrSHhYbghcASLOyW2FD27mRwjPzTLLRIjibZ+iqYCE7FU5D+Knwu+PLkaANe2QHDroGsAJisVWKerhq1KnDSLGEkG3uxvyJKkuHwc6x+ugSM0kxAM4SZoDBTyxALZddnmaA48uZIdn3Q3AtCeXiDxeKZNJij/3BUNpUXhwFKMlJkF8kXEAYVTwtKQRBjkX2McIqqkWcTHb9epmEQITrue/H9NbkrSHMBP9HMFvEHQIHVpqFL8OOUCC0ArcGPvRf8RBknM6olszXmlwCRtg8QkYNvKCYsznxtAZxAr+AEVZdJqu5YR9hkii6/XRObjqEuzKTr3YKTLvsib8k8MqtXLYHOoEQQgiqjpiqCUsita/Ooywi5iPFdEL4wct6zLyy7Hb27wpYuq3b7YYGGNZZRp1JjrcYjay8iPnvugpgnE2Lkl5mcax75N0coDaLpQUu9tAJcBzh7k3r2QC+ycAMJYKku5gzVfHZHDhPQhNWcVddhEpeFoGNrZbzlrIahmk9kyjwU7JVjQJ7vV8HuQeUc+k72AYl+r7IwbGfBV3VeYWAuSYnnvY4zaXc4nuI0RQeeB7ds0LNqOBKVkR9kNm2ePfjWtc5wiazrkKfxesnYG43dvXy8qihbTVjJj6RQGwvZrQMivwtnyoMjDeOTcpADDizOZli8mQMarOk2GoCfyRQmatlrtOTFXxqkYUlM3kfJJA4WaYAj+WRCHjO9LQ/mb88D+MvY2zpfukwkTTnAyP+xYfIMZqv/3gL/1n7LzjYC/+UhVg7EHB7F7K0w1rTLpBzFUV1JdAVJLi9na0HbG5LEwgTA3LGuMKnnwtheV7KMa9Xy13hl7MtQBUqokngPWQRxgZMkGOfBRD/L6x6SQymtZyFz6PpyKC05YkDjBLfkPtnEEoq/CjNq2nw9GgQyIzq2o3L1xLsdrYFjQ4sIixrvGHXtqG2euIU/Z/e8LVtVe1CBsK6tqmp+wh5WfBho/fpCe1bhbC+07ouflmp1RFf8dPrVwkPnp93bftjJw2N4+WT/ufKubn9//Pr58+z+mG3QOgztLKVcy0wspVqvLDuoxWV5jJb5i7titANgs9Un0lpy+eCrLGMxWJ1kf8Vb29JI4lr0EPPZuhCe1y2Z3B1voXMPyebs2HpXY8HbMJLZqrFeAIblRtpy1iaIHoIUraiTBpNg4dEN7QejalDjIzyW1nOoze7ZV+91xWyrdjuxh9VUaB3ve19h1eOn23gEpDw8Zhg6Fx0T3BqWNe0qOia3yXkmJM0e4MELwmBM/qXPB+06QmEPWv+eI9D69WUGq6uq1axMageCvfaWatYRLSvbrUrDdU1MQXFgz2sAWy6PXC5WmT5tU21zngnGeqftaPee2gFTH+rusPxCV/a+aapbyWQMl9IGI9lQBN2FEqVX6xy/NNnNKg1uM10ovyJGd4iQbVJSjZbXsJVsVo98iYcHmECHBg9i/efP3f36X7yx0lh1fx0q+gA91aFZDuTnUC+NFerQLF2YqeU1gSsHNneV2mxpkKHSBmNb/4vXWxYLeJtu949GjRbq799xrBKnakBSWYONhmGK6YhaMmgwKMU2HjBksd2GMMoWBbTtLmls/2rrclsjE7lJGpxokA9mnhjEwNWwzE1bWdUNKO6wumxIVtYWfXDlLhtCvw4bqgnwvh101+Vu7HtoPVqr/XMB6LdAY88QfmcBJqDecHJYVeagpCvkBEd3QTynO4k06oZtcZEICb0wRCGext48WxAW8IU7VwAe5UaSW3hoj/Ig710QhtxqfjRqt8EksOwTk1O60t7LgC01uon5goNqe96hSpa0HNvV0L/vjuiGLez0N5wOOqKvyVQAgJi2hX3X/PVmCUto3muxTX896r28ms5jee+4Le0YFba6WCWL46aY90+C4uvxv9n7rKAWemMUsjXEKvYwA5vW56uR7L0fHI+sP0vMThwnOQCfkgtsuHjanGSzfGE1YNoN7TEVs4nJk63m5r+PDBcfIqd5SFg6w6GPYv6dW3nn0nzghxcH3ph1L6hoNF0sVKSyXBBBwrZ01yqJLqmKYkKHvDCYRuRwQiQkF8hMCIKJF57SE/PA98NtIRtMrr4LcwGdketQJIpsawJoa3wegKwymWgVRNCyywI04vJBQQbJYUEM1cTSqCuWhlMmlldomsf5KyXRaFcSnXdJ3JWQIoIIZUGEZUUL4u6qenKo2qq+LHhIg7dMYL6dfrgsSNL4aOsrJVqoKenahpnAEpcebgnnOi430eXErcSm0/Pvn66/qjHq5ZlcTos6Z5IORCbZLCDWW3mzXhbPFHh08+mCqJJ2ORpdnn9XYtUbdCMNV8BOp8SGd7wGYAm8Xcy9WNvbTd7r++nZlRp4tpgKq+IzjQt0r8US1K79t96yaUCvldxXykTsR8ihBOwdwad2RUdZOeUkzpQFRTtOOum1Wh+8Xu42xtwh8LbWeyFeL2+b09zKiVpnrRyCe2dthboNUnNLKyzKFjeVzK0up9svX1KrTGBrmUqLm5iV27wVQzLdS6guvB1Tt+pWqtjCC/1cTZipoUS/1NFSp6UKTeWFtrcUKGtl23LLMclPV5XR7dFXccux4XRXhV1KW3lrVCPA0kCdboMosUuqFHtY9QcStnViA82yHQAcyxQzs5ao6Xt0sNo5sWm2BCGmzmMVe3FtqxAiN4ygENLNjurmkUSo7Opy30wpgWt5n5X98urUI+7r1LSMPS9rTuD266EIyWrbqAk2kC/JdfSWsAWYfB8+myZvtoKgdAPd5tgqGDXbNr5O7XjzvSXb0xVXWVdgn7piOM6uLe9Q2PKuqjmGy6uODttRHVPj48zQ4TRnX0UghzHGafFyYjRnX7CfZfsv/w8= \ No newline at end of file diff --git a/research/meetingscheduler.jpg b/research/meetingscheduler.jpg new file mode 100644 index 0000000..97ed649 Binary files /dev/null and b/research/meetingscheduler.jpg differ diff --git a/research/meetingscheduler.png b/research/meetingscheduler.png deleted file mode 100644 index c38882b..0000000 Binary files a/research/meetingscheduler.png and /dev/null differ