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

Remove outdated timezones from examples

Browse Source
This commit is contained in:
rui hildt 2020-08-27 12:48:32 +02:00
parent 752d731865
commit 9d399da956
1 changed files with 7 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
api-documentation.md
View File

@ -165,7 +165,6 @@ A json object for the specified account with an array of `meeting`.
"title": "Worldwide meeting I", "title": "Worldwide meeting I",
"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": "10:30:00", "start_time": "10:30:00",
"timezone": "Europe/Brussels",
"duration": 90, "duration": 90,
"status": false "status": false
}, },
@ -174,7 +173,6 @@ A json object for the specified account with an array of `meeting`.
"title": "Worldwide meeting II", "title": "Worldwide meeting II",
"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": "08:00:00", "start_time": "08:00:00",
"timezone": "America/New_York",
"duration": 90, "duration": 90,
"status": false "status": false
}, },
@ -183,7 +181,6 @@ A json object for the specified account with an array of `meeting`.
"title": "Worldwide meeting III", "title": "Worldwide meeting III",
"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": "14:30:00", "start_time": "14:30:00",
"timezone": "Asia/Kolkata",
"duration": 90, "duration": 90,
"status": false "status": false
} }
@ -246,7 +243,7 @@ A json object for the added meeting with `id`, `title`, `description`, `start_ti
##### Request ##### Request
A json object for the meeting to update with any of `title`, `description`, `start_time`, `timezone`, `duration`, `status` and `password`. A json object for the meeting to update with any of `title`, `description`, `start_time`, `duration`, `status` and `password`.
``` ```
{ {
@ -257,7 +254,7 @@ A json object for the meeting to update with any of `title`, `description`, `sta
##### Response `200` ##### Response `200`
A json object for the updated meeting with `id`, `title`, `description`, `start_time`, `timezone`, `duration` and `status`. A json object for the updated meeting with `id`, `title`, `description`, `start_time`, `duration` and `status`.
``` ```
{ {
@ -323,7 +320,6 @@ A json object for the specified meeting with an array of `participant`.
"mandatory": false, "mandatory": false,
"host": false, "host": false,
"answered": false, "answered": false,
"timezone": "Europe/Brussels"
}, },
{ {
"account_id": 2, "account_id": 2,
@ -334,7 +330,6 @@ A json object for the specified meeting with an array of `participant`.
"mandatory": false, "mandatory": false,
"host": false, "host": false,
"answered": false, "answered": false,
"timezone": "America/New_York"
} }
] ]
@ -463,7 +458,7 @@ A json object for the participant to add with **`account_id`**, **`meeting_id`**
##### Response `201` ##### Response `201`
A json object for the participant with `id`, `account_id`, `meeting_id`, `quorum`, `mandatory`, `host`, `answered` and `timezone`. A json object for the participant with `id`, `account_id`, `meeting_id`, `quorum`, `mandatory`, `host` and `answered`.
``` ```
{ {
@ -473,7 +468,6 @@ A json object for the participant with `id`, `account_id`, `meeting_id`, `quorum
"mandatory": 1, "mandatory": 1,
"host": 0, "host": 0,
"answered": 0, "answered": 0,
"timezone": "Europe/Brussels"
} }
``` ```
@ -483,7 +477,7 @@ A json object for the participant with `id`, `account_id`, `meeting_id`, `quorum
##### Request ##### Request
A json object for the participant to invite with any of `quorum`, `mandatory`, `host`, `answered` and `timezone`. A json object for the participant to invite with any of `quorum`, `mandatory`, `host` and `answered`.
``` ```
{ {
@ -495,7 +489,7 @@ A json object for the participant to invite with any of `quorum`, `mandatory`, `
##### Response `200` ##### Response `200`
A json object for the participant with `account_id`, `meeting_id`, `quorum`, `mandatory`, `host`, `answered` and `timezone`. A json object for the participant with `account_id`, `meeting_id`, `quorum`, `mandatory`, `host` and `answered`.
``` ```
{ {
@ -505,7 +499,6 @@ A json object for the participant with `account_id`, `meeting_id`, `quorum`, `ma
"mandatory": 1, "mandatory": 1,
"host": 1, "host": 1,
"answered": 1, "answered": 1,
"timezone": "Europe/Brussels"
} }
``` ```
@ -605,7 +598,6 @@ A json object for the deleted possible date with `message`.
| preference | boolean | `0` (ideal) or `1` (yes), required | | preference | boolean | `0` (ideal) or `1` (yes), required |
| start_time | datetime | required | | start_time | datetime | required |
| end_time | datetime | required | | end_time | datetime | required |
| timezone | string | required |
| created_at | datetime | generated by database | | created_at | datetime | generated by database |
| updated_at | datetime | generated by database | | updated_at | datetime | generated by database |
@ -615,7 +607,7 @@ A json object for the deleted possible date with `message`.
##### Request ##### Request
A json object with the availability to add with **`participant_id`**, **`possible_date_id`** and an array of intervals with **`preference`**, **`start_time`**, **`end_time`** and **`timezone`**. A json object with the availability to add with **`participant_id`**, **`possible_date_id`** and an array of intervals with **`preference`**, **`start_time`** and **`end_time`**.
``` ```
{ {
@ -625,14 +617,13 @@ A json object with the availability to add with **`participant_id`**, **`possibl
"preference": false, "preference": false,
"start_time": "23:00:00", "start_time": "23:00:00",
"end_time": "23:59:00", "end_time": "23:59:00",
"timezone": "Europe/Brussels"
} }
``` ```
##### Response `201` ##### Response `201`
A json object with the availability added with **`id`**, **`account_id`**, **`meeting_id`**, **`possible_date_id`** and an array of intervals with **`id`**, **`preference`**, **`start_time`**, **`end_time`** and **`timezone`**. A json object with the availability added with **`id`**, **`account_id`**, **`meeting_id`**, **`possible_date_id`** and an array of intervals with **`id`**, **`preference`**, **`start_time`** and **`end_time`**.
``` ```
{ {
@ -643,7 +634,6 @@ A json object with the availability added with **`id`**, **`account_id`**, **`me
"preference": false, "preference": false,
"start_time": "23:00:00", "start_time": "23:00:00",
"end_time": "23:59:00", "end_time": "23:59:00",
"timezone": "Europe/Brussels"
} }
``` ```