Public

Events1 EndpointsEvent / Public

GET/api/event/public/unified_event_details/{identifier}

Path parameters

identifierrequiredstring

Responses

200Get event + future bookings + test adding a new BaseEventSignUp as customer / publicBaseEvent25

Show fields (81)

ticketSeatingPlanIdinteger
Id of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledboolean
timing_enabledboolean
idinteger
Primary key of the event. Internal ID.
tokenstring
Public token of the event. Used in links and QR codes instead of the ID.
moments_modestring
Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
moments_designstring
Visual theme of the moments (digital guestbook) pages and exports.
public_keywordsstring
Keywords shown in the public event listing.
public_subtitlestring
Subtitle shown in the public event listing.
event_typestring
Type of the event, for example course, trip or tournament.
age_groupstring
Age group the event is intended for, for example children or adults.
min_ageinteger
Minimum age in years of participants.
max_ageinteger
Maximum age in years of participants.
min_age_monthsinteger
Minimum age in months of participants, for events for infants.
max_age_monthsinteger
Maximum age in months of participants, for events for infants.
min_grade_levelinteger
Minimum school grade level of participants.
max_grade_levelinteger
Maximum school grade level of participants.
age_toleranceinteger
Years by which participants may be outside the age range and still sign up.
event_people_limitinteger
maximum number of people that can attend the event
event_people_min_limitinteger
minimum number of people that must attend the event
hide_event_people_limitboolean
a setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitinteger
Maximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitinteger
Maximum number of participants who are neither recovered nor vaccinated.
has_wait_listboolean
The event has a waiting list once it is full.
wait_list_confirmation_requiredboolean
Participants from the waiting list must confirm their place.
trial_enabledboolean
Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
can_sign_up_for_main_eventboolean
Participants may sign up for the main event.
only_sign_up_for_main_eventboolean
Participants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeinteger
Number of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeinteger
Number of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeinteger
Hours before the start until which a participant can cancel the sign-up.
start_timestring (date-time)
Start of the event.
end_timestring (date-time)
End of the event.
require_addressboolean
Participants must enter an address when signing up.
require_contactboolean
Participants must enter contact details when signing up.
require_billingboolean
Participants must enter billing details when signing up.
allow_direct_billingboolean
require_direct_billingboolean
allow_budget_sign_upboolean
require_ageboolean
Participants must enter their age when signing up.
require_grade_levelboolean
Participants must enter their school grade level when signing up.
require_free_note_field_idsstring
IDs of the free note fields that participants must fill in.
generate_new_bookingsboolean
Bookings are generated automatically for the event schedule.
generate_new_bookings_v2boolean
Bookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarboolean
Generated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingboolean
Sign-ups of the main event are copied to the generated bookings.
generate_hour_startstring (date-time)
Start time of the day for generated bookings.
generate_hour_endstring (date-time)
End time of the day for generated bookings.
generate_day_of_weekinteger
Weekday for generated bookings.
bitmask_days_of_weekinteger
This is a bitmask value of the days of the week the event occurs on
bitmask_hours_startinteger
This is a bitmask value of the hours an event starts on
summarized_date_timesstring
This is a string with the days and hours an event starts on
customer_detail_ctastring
Call-to-action text shown in the customer app on the event detail page.
customer_badgestring
Badge text shown on the event in the customer app.
bib_number_modestring
Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
timing_gun_startstring (date-time)
Startschuss; ohne Wert gilt startTime.
timing_rank_bystring
Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsinteger
Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_liveboolean
Live timing results are public.
timing_gps_trackingboolean
GPS tracking of participants is enabled for timing.
timing_self_check_inboolean
Participants can check in themselves for timing.
scoreboard_enabledboolean
Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
scoreboard_sportstring
Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
scoreboard_home_namestring
Name of the home team on the scoreboard.
scoreboard_away_namestring
Name of the away team on the scoreboard.
ticket_sales_enabledboolean
Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.
ticket_max_per_orderinteger
Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.
ticket_personalizedboolean
Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.
ticket_seatingboolean
Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
… 16 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/public/unified_event_details/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/event/public/unified_event_details/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/event/public/unified_event_details/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/public/unified_event_details/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/public/unified_event_details/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/event/public/unified_event_details/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/event/public/unified_event_details/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'package:http/http.dart' as http;

final response = await http.get(
  Uri.parse('https://your-instance.iw-erp.de/api/event/public/unified_event_details/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "scoreboard_home_name": "Beispiel",
  "scoreboard_away_name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org"
}