diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 090235d..909e3f7 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -71,7 +71,6 @@ export default { { text: 'Authentication', link: '/de/api/auth' }, { text: 'Gruppen', link: '/de/api/groups' }, { text: 'Events', link: '/de/api/events' }, - { text: 'Styles', link: '/de/api/styles' }, { text: 'RSVP', link: '/de/api/rsvp' }, { text: 'Verschiedenes', link: '/de/api/miscellaneous' }, ] @@ -192,7 +191,6 @@ export default { { text: 'Authentication', link: '/api/auth' }, { text: 'Groups', link: '/api/groups' }, { text: 'Events', link: '/api/events' }, - { text: 'Styles', link: '/api/styles' }, { text: 'RSVP', link: '/api/rsvp' }, { text: 'Miscellaneous', link: '/api/miscellaneous' }, ] diff --git a/src/api/events.md b/src/api/events.md index ef818c4..6c057ba 100644 --- a/src/api/events.md +++ b/src/api/events.md @@ -7,7 +7,7 @@ GET /event/:id ``` -Reading an event does not allow for any additional parameters. +Reading an event does not allow for any additional parameters. It only takes the proKey/id in the request url. It simply provides you with all data for a specific event. ### Potential response @@ -63,20 +63,104 @@ It simply provides you with all data for a specific event. ] ``` +
+ ## Add an event ``` POST /event ``` +Creating a new event requires you to at least provide the following fields in the body: + +```json +{ + "event_group": "prokey-of-event-group", // gets returned as "id", when creating a group + "dates": [{ + "name": "Title of the date", + "startDate": "2024-12-24", + "timeZone": "America/Los_Angelese" // not required, but highly recommended + }], +} +``` + +Instead of `event_group`, you can also use `new_event_group_name`, which takes a string. This will create a new group with the provided name instead of linking the event to an existing one. + +Going further, you can add more dates to the array (= multi-date event) and add all fields, which are also present in the application's UI. + +::: warning Limitations +Mind limitations, like recurrence not allowing for multiple dates, etc. +We recommend to create a potential setup in the application first, before building it via the API. +Additionally, the API does not allow to set the status of an event - it will always be published on creation. +::: + +### Potential request with all fields + +```json +{ + "event_group": "prokey-of-event-group", // gets returned as "id", when creating a group + "dates": [{ + "name": "Title of the date", + "description": "

An event description

", // allowing for

, , , ,

,

,

,

,