REST API#
The backend adds two endpoints to the event root.
The event root is the Plone site in single event mode, and a Tech Event item in multiple events mode.
Both endpoints are available with GET and need no request body.
@schedule#
Returns the slots of the event, grouped by day.
Permission: zope2.View
Request
GET /Plone/@schedule HTTP/1.1
Accept: application/json
Response
The response is an object with an items list.
Each item is one day, and it has these keys:
Key |
Description |
|---|---|
|
The date of the day, as |
|
The slots of the day, sorted by start time. Each slot is a summary of the content, with the layout keys listed below. |
|
The rooms used on the day, as a list of |
Each slot in items has the summary fields of the content, such as @id, @type, title, start, end and room.
The endpoint also adds these layout keys:
Key |
Description |
|---|---|
|
The column of the slot, such as |
|
The rows of the slot, such as |
|
The duration of the slot, in quarters of an hour. |
Trainings that last more than four hours are split into two slots for the display.
The following example shows the structure of the response, with one slot.
{
"items": [
{
"id": "2027-05-10",
"items": [
{
"@type": "Talk",
"title": "Opening remarks",
"start": "2027-05-10T09:00:00+00:00",
"end": "2027-05-10T09:30:00+00:00",
"room": [
{
"token": "main-room",
"title": "Main room"
}
],
"gridColumn": "room-1",
"gridRow": "time-0900 / time-0930",
"gridHeight": 2
}
],
"rooms": [
[
"main-room",
"Main room"
]
]
}
]
}
@sponsors#
Returns the published sponsors, grouped by level, and the benefits of each level.
Permission: zope2.Public
Request
GET /Plone/@sponsors HTTP/1.1
Accept: application/json
Response
Key |
Description |
|---|---|
|
URL of the sponsors database. |
|
The sponsorship levels, in order. |
|
The benefits of the event, with the value that each level gives to each benefit. |
Each level in items has these keys:
Key |
Description |
|---|---|
|
URL of the level. |
|
ID of the level. |
|
Title of the level. |
|
The published sponsors of the level, as summaries. |
|
|
|
Whether the level is excluded from navigation. |
|
The image scales of the level. |
Each benefit in benefits has these keys:
Key |
Description |
|---|---|
|
ID of the benefit. |
|
Title of the benefit. |
|
Description of the benefit. |
|
An object that maps the ID of each level to the value of the benefit for that level. |
The following example shows the structure of the response, with one level and one benefit.
{
"@id": "https://example.org/Plone/sponsors-db",
"items": [
{
"@id": "https://example.org/Plone/sponsors-db/gold",
"id": "gold",
"title": "Gold",
"items": [],
"has_sponsors": false,
"exclude_from_nav": false,
"image_scales": {}
}
],
"benefits": [
{
"id": "booth",
"title": "Booth",
"description": "A booth in the sponsors area.",
"levels": {
"gold": "Large"
}
}
]
}