meeting-planner/documentation
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update Accounts responses

Browse Source
This commit is contained in:
rui hildt 2020-05-04 15:14:28 +02:00
parent 75dc3abaef
commit 3292cd740d
1 changed files with 37 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
api-documentation.md
View File

@ -43,14 +43,12 @@ A json object for the registered account with `id`, `username`, `email`, `timezo
``` ```
{ {
"data": { "id": 1,
"id": 1, "username": "jean",
"username": "jean", "email": "jean@example.com",
"email": "jean@example.com", "timezone": "Europe/Brussels",
"timezone": "Europe/Brussels", "earliest_time":"09:30 AM",
"earliest_time":"09:30 AM", "latest_time":"10:00 PM"
"latest_time":"10:00 PM"l
}
} }
``` ```
@ -75,14 +73,12 @@ A json object for the registered account with `id`, `username`, `email`, `timezo
``` ```
{ {
"data": { "id": 1,
"id": 1, "username": "jean",
"username": "jean", "email": "jean@example.com",
"email": "jean@example.com", "timezone": "Europe/Brussels",
"timezone": "Europe/Brussels", "earliest_time":"09:30 AM",
"earliest_time":"09:30 AM", "latest_time":"10:00 PM"l
"latest_time":"10:00 PM"l
}
} }
``` ```
@ -108,14 +104,12 @@ A json object for the registered account with `id`, `username`, `email`, `timezo
``` ```
{ {
"data": { "id": 1,
"id": 1, "username": "jean",
"username": "jean", "email": "jean@example.com",
"email": "jean@example.com", "timezone": "Europe/Brussels",
"timezone": "Europe/Brussels", "earliest_time": "09:30 AM",
"earliest_time": "09:30 AM", "latest_time": "10:00 PM"
"latest_time": "10:00 PM"
}
} }
``` ```
@ -135,15 +129,11 @@ A json object for the account to delete with `id`.
##### Response `200` ##### Response `200`
A json object for the deleted account with `id`, `username` and `email`. A json object for the deleted account with confirmation message.
``` ```
{ {
"data": { "message": "Account with id 15 successfully deleted."
"id": 15,
"username": "jean",
"email": "jean@example.com"
}
} }
``` ```
@ -166,24 +156,23 @@ A json object with an `account_id`.
A json object for the specified account with an array of `meeting`. A json object for the specified account with an array of `meeting`.
``` ```
{ [{
"data": [{ "id": "f86983db-955e-43b8-be3e-bc92bbeb9b43",
"id": "f86983db-955e-43b8-be3e-bc92bbeb9b43", "title": "Worldwide strategy meeting for growth",
"title": "Worldwide strategy meeting for growth", "description": "Let's find the best ethical growth hacking technics together. Yeah, fun.",
"description": "Let's find the best ethical growth hacking technics together. Yeah, fun.", "start_time": "2022-02-16 20:00:00",
"start_time": "2022-02-16 20:00:00", "timezone": "Europe/Brussels",
"timezone": "Europe/Brussels", "duration": 60,
"duration": 60, "status": 1
"status": 1 },
}, {
{ "id": "follow-up-with-tech-team-21850",
"id": "follow-up-with-tech-team-21850", "title": "Follow up with tech team",
"title": "Follow up with tech team", "duration": 120,
"duration": 120, "status": 0
"status": 0 }
} ]
]
}
``` ```
### **Meetings** | `meeting` ### **Meetings** | `meeting`