Events¶
Resource description¶
The event resource contains the following public fields:
Field |
Type |
Description |
---|---|---|
name |
multi-lingual string |
The event’s full name |
slug |
string |
A short form of the name, used e.g. in URLs. |
is_public |
boolean |
If |
date_from |
datetime |
The event’s start date |
date_to |
datetime |
The event’s end date (or |
timezone |
string |
The event’s chosen time zone |
urls |
object |
Contains URLs to relevant event pages. |
Added in version 1.1: The urls
field.
Endpoints¶
- GET /api/events/¶
Returns a list of all events the authenticated user/token has access to, or all public events for unauthenticated users.
Example request:
GET /api/events/ HTTP/1.1 Accept: application/json, text/javascript
Example response:
HTTP/1.1 200 OK Vary: Accept Content-Type: application/json { "count": 1, "next": null, "previous": null, "results": [ { "name": {"en": "Sample Conference"}, "slug": "sampleconf", "timezone": "Europe/berlin", "date_from": "2017-12-27T10:00:00Z", "date_to": null, "is_public": true, "urls": { "base": "https://…/sampleconf", "schedule": "https://…/sampleconf/schedule/", "login": "https://…/sampleconf/login/", "feed": "https://…/sampleconf/schedule/feed.xml", } } ] }
- Query Parameters:
page – The page number in case of a multi-page result set, default is 1
- GET /api/events/(event)/¶
Returns information on one event, identified by its slug.
Example request:
GET /api/events/sampleconf/ HTTP/1.1 Accept: application/json, text/javascript
Example response:
HTTP/1.1 200 OK Vary: Accept Content-Type: application/json { "name": {"en": "Sample Conference"}, "slug": "sampleconf", "timezone": "Europe/berlin", "date_from": "2017-12-27T10:00:00Z", "date_to": null, "is_public": true, "urls": { "base": "https://…/sampleconf", "schedule": "https://…/sampleconf/schedule/", "login": "https://…/sampleconf/login/", "feed": "https://…/sampleconf/schedule/feed.xml", } }
- Parameters:
event – The
slug
field of the event to fetch
- Status Codes:
200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The requested event does not exist or you have no permission to view it.