Back to top

Event

Which values can be send?

Permissions

  • An API key is needed
  • An X-CSRF-Token is needed

Fields

Name Description Format Possible values
Type Type of content
{
  ...
  "type": [ {
    "target_id": "event"
  } ],
  ...
}
mandatory
 
Title name of the event
{
  ...
  "title": [ {
    "value": "Name of Event"
  } ],
  ...
}
mandatory
String
Subtitle subtitle of the event
{
  ...
  "field_subtitle": [ {
    "value": "Subtitle of event"
  } ],
  ...
}
String
Pictures pictures of the event
{
  ...
  "pictures": [ {
    "url": "http://example.com/image.jpg",
    "copy": "Copyright information",
    "alt": "Text for screenreaders"
  } ],
  ...
}
multiple values

Array

  • Url (mandatory)
  • String
  • String
Event type type of the event
{
  ...
  "field_event_type": [ {
    "value": "1" 
  } ],
  ...
}
mandatory
1 | Single or several dates
2 | Regularly recurring event
3 | Long or permanent event
Dates and timings
List
list of dates and timing of the event
{
  ...
  "field_date":[ {
    "value": "[DATEFROM]",
    "end_value": "[DATETO]",
    "rrule": "[RRULE or NULL]",
  } ],
  ...
}
multiple valuesmandatory
Dates and timings in format
YYYY-MM-DD\THH:MM:SS

Dates and timings
Opening hours

Opening hours in case of a long or permanent event
{
  ...
  "field_opening_hours":[ {
    "day": [DAY],
    "starthours": [STARTHOURS],
    "endhours": [ENDHOURS]
  }],
  ...
}
multiple values

Day 1-7 (1 = Monday)

Integer (ex. 20h00 => 2000)

Dates and timings
Exeptionnally closed
Dates on which the long or permanent event is closed
{
  ...
  "field_exceptionally_closed_on":[ {
    "value": "2019-12-25",
    "value": "2019-12-26"
  } ],
  ...
}
multiple values
Dates in format
YYYY-MM-DD

Venues

list of venue IDs of the event
{
  ...
  "field_location":[ {
    "target_id": [ID]
  } ],
  ...
}
mandatory

Specifications are available on the API reference venues page.

Reference ID
No fix location the event has no fix location
{
  ...
  "field_no_fix_location":[ {
    "value": [true OR false]
  } ],
  ...
}
Boolean
Prices entrance fees for the event
{
  ...
  "field_prices":[ {
    "first": "[DESCRIPTION]",
    "second": [PRICE]
  } ],
  ...
}
String, Float
Free of charge no entrance fees for the event
{
  ...
  "field_freeofcharge":[ {
    "value": [true OR false]
  } ],
  ...
}
Boolean
Description DE German event description
{
  ...
  "field_description_de":[ {
    "value": "[HTML]"
  } ],
  ...
}
HTML text
Description FR French event description
{
  ...
  "field_description_fr": [ {
    "value": "[HTML]"
  } ],
  ...
}
HTML text
Description EN English event description
{
  ...
  "field_description_en":[ {
    "value": "[HTML]"
  } ],
  ...
}
HTML text
Description LU Luxembourgish event description
{
  ...
  "field_description_lu":[ {
    "value": "[HTML]"
  } ],
  ...
}
HTML text
Main category event category
{
  ...
  "field_categories":[ {
    "target_id": [ID]
  } ],
  ...
}

Specifications are available on the API reference category page.

mandatory

Reference ID

Secondary category event category
{
  ...
  "field_secondary_category":[ {
    "target_id": [ID]
  } ],
  ...
}

Specifications are available on the API reference category page.

Reference ID
Audience event audience
{
  ...
  "field_type":[ {
    "target_id": [ID]
  } ],
  ...
}

Specifications are available on the API reference audience page.

mandatory

Reference ID

Tags keywords describing the event
{
  ...
  "field_tags_rest": [ {
    "value": "[tag1],[tag2],[tag3]"
  } ],
  ...
}
string
Contact email Public contact or support email addresses
{
  ...
  "field_contact_email":[ {
    "first": "[EMAIL]",
    "second": null
  } ],
  ...
}
email address
Contact phone number Public contact or support phone number
{
  ...
  "field_contact_phonenumber":[ {
    "first": "[PHONE]",
    "second": null
  } ],
  ...
}
string
Websites Websites of the event
{
  ...
  "field_websites":[ {
    "uri": "[URL]",
    "title": "[LINKTITLE]"
  } ],
  ...
}
string (URL)
Online tickets Links to an online ticket shop
{
  ...
  "field_tickets_online":[ {
    "datetime": "[DATE]",
    "link": "[LINK]",
    "id": [ID]
  } ],
  ...
}
multiple values
  • Dates in format
    YYYY-MM-DD\THH:MM:SS
  • string (URL)
  • integer
Sales email address Sales email address for the event
{
  ...
  "field_sales_email_address":[ {
    "value": "[EMAIL]"
  } ],
  ...
}
email address
Sales phone number Sales phone number for the event
{
  ...
  "field_sales_phone_number":[ {
    "value": "[PHONE]"
  } ],
  ...
}
string
Sales start date Sales start date for the tickets
{
  ...
  "field_sales_start_date":[ {
    "value": "[DATE]"
  } ],
  ...
}
string
Sales organisation Sales organisation for this event
{
  ...
  "field_tickets_sold_by":[ {
    "value": "[ORGANISATION]"
  } ],
  ...
}
string
Sales website Link for more information
{
  ...
  "field_url":[ {
    "uri": "[URL]"
  } ],
  ...
}
string (URL)
Organizer Name of the organizer
{
  ...
  "field_organizer":[ {
    "value": "[NAME]"
  } ],
  ...
}
string
State State of the event
{
  ...
  "field_state":[ {
    "value": "[STATE]"
  } ],
  ...
}

string

  • scheduled
  • canceled
  • deleted
User email address Account e-mail address of the acting user
{
  ...
  "field_email_address":[ {
    "value": "[EMAIL]"
  } ],
  ...
}
mandatory
 

 

Examples

Single or several dates (JSON)

{ 
    "type":[ 
        { 
            "target_id":"event"
        }
    ],
    "title":[ 
        { 
            "value":"Example 1"
        }
    ],
    "field_subtitle":[ 
        { 
            "value":"Event type 1"
        }
    ],
    "field_event_type":[ 
        { 
            "value":"1"
        }
    ],
    "field_date":[ 
        { 
            "value":"2019-10-01T08:00:00",
            "end_value":"2019-10-01T17:00:00"
        }
    ],
    "field_type":[ 
        { 
            "target_id":"6"
        }
    ],
    "field_state":[ 
        { 
            "value":"scheduled"
        }
    ],
    "field_email_address":[ 
        { 
            "value":"mail@example.com"
        }
    ],
    "pictures":[ 
        { 
            "url":"https://eventsinluxembourg.lu/sites/default/files/LOGO_EVENTS_IN_LUXEMBOURG_RGB_1.png",
            "copy":"Copyright by EIL",
            "alt":"EIL-Logo"
        }
    ],
    "field_location":[ 
        { 
            "target_id":"98525"
        }
    ],
    "field_description_en":[ 
        { 
            "value":"An Event with a single date"
        } 
    ], 
    "field_categories":[ 
        { 
            "target_id":"24347" 
        } 
    ], 
    "field_prices":[ 
        { 
            "first":"Children", 
            "second":0 
        }, 
        { 
            "first":"Over 18", 
            "second":7.5 
        } 
    ], 
    "field_websites":[ 
        { 
            "uri":"http://example.com" 
        } 
    ] 
}
Regularly recurring event (JSON)

{ 
    "type":[ 
        { 
            "target_id":"event"
        }
    ],
    "title":[ 
        { 
            "value":"Example 2"
        }
    ],
    "field_subtitle":[ 
        { 
            "value":"Event type 2"
        }
    ],
    "field_event_type":[ 
        { 
            "value":"2"
        }
    ],
    "field_date":[ 
        { 
            "value":"2019-09-16T08:00:00",
            "end_value":"2019-09-16T12:00:00",
            "rrule":"RRULE:FREQ=WEEKLY;BYDAY=MO;UNTIL=20200914T000000Z"
        }
    ],
    "field_exceptionally_closed_on":[
        {
            "value": "2019-12-23"
        }
    ],
    "field_type":[ 
        { 
            "target_id":"6"
        }
    ],
    "field_email_address":[ 
        { 
            "value":"mail@example.com"
        }
    ],
    "field_location":[ 
        { 
            "target_id":"98525"
        }
    ],
    "field_description_en":[ 
        { 
            "value":"Every monday from 16/09/2019 until 14/09/2020 except on 23/12/2019"
        }
    ],
    "field_categories":[ 
        { 
            "target_id":"24347"
        }
    ]
}
Long or permanent event (JSON)

{ 
    "type":[ 
        { 
            "target_id":"event"
        }
    ],
    "title":[ 
        { 
            "value":"Example 3"
        }
    ],
    "field_subtitle":[ 
        { 
            "value":"Event type 3"
        }
    ],
    "field_event_type":[ 
        { 
            "value":"3"
        }
    ],
    "field_date":[ 
        { 
            "value":"2019-10-01T00:00:00",
            "end_value":"2020-10-01T00:00:00"
        }
    ],
    "field_opening_hours":[ 
        { 
            "day":1,
            "starthours":1000,
            "endhours":1200
        },
        { 
            "day":1,
            "starthours":1400,
            "endhours":1700
        },
        { 
            "day":3,
            "starthours":800,
            "endhours":1700
        },
        { 
            "day":5,
            "starthours":800,
            "endhours":1700
        },
        { 
            "day":6,
            "starthours":1600,
            "endhours":2000
        }
    ],
    "field_type":[ 
        { 
            "target_id":"6"
        }
    ],
    "field_email_address":[ 
        { 
            "value":"mail@example.com"
        }
    ],
    "field_location":[ 
        { 
            "target_id":"98525"
        }
    ],
    "field_description_en":[ 
        { 
            "value":"From 01/10/2019 until 01/10/2020<br>Mon: 10:00-12:00, 14:00-17:00<br> Wed: 08:00-17:00<br> Fri: 08:00-17:00<br>Sat: 16:00-20:00"
        }
    ],
    "field_categories":[ 
        { 
            "target_id":"24347"
        }
    ]
}