Event

Veranstaltungen8 EndpunkteEvent / Event

Liefert eine Liste der Veranstaltungen.

GET/api/event/base_event

Query-Parameter

`name`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`token`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`baseLocation`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`baseBookable`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`secondaryBaseBookable`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`eventType`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`ageGroup`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`processedMinAge`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`processedMaxAge`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`generateDayOfWeek`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`bitmaskDaysOfWeek`string	Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet \| Benötigtes Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`bitmaskHoursStart`string	Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt \| Benötigtes Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`orderStringOne`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`orderStringTwo`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`orderWeekday`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`orderWeekdayOngoing`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`startTime`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`endTime`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`slugIdentifier`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`created`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`updated`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`minGradeLevel`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`maxGradeLevel`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`highlight`boolean	Diese Eigenschaft markiert eine Entität als hervorgehoben \| Benötigtes Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`trialEnabled`boolean	Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel. \| Benötigt Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`deleted`boolean	Diese Eigenschaft markiert eine Entität als gelöscht / archiviert \| Benötigtes Zugriffsrecht: SCOPE
`requireAge`boolean
`requireGradeLevel`boolean
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der Veranstaltungen.array<BaseEvent>

Felder anzeigen (81)

ticketSeatingPlanIdinteger
ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
bib_numbers_enabledboolean
timing_enabledboolean
idinteger
Primärschlüssel der Veranstaltung. Interne ID.
tokenstring
Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
moments_modestring
Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
moments_designstring
Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
public_keywordsstring
Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
public_subtitlestring
Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
event_typestring
Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
age_groupstring
Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
min_ageinteger
Mindestalter der Teilnehmenden in Jahren.
max_ageinteger
Maximales Alter der Teilnehmer in Jahren.
min_age_monthsinteger
Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
max_age_monthsinteger
Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
min_grade_levelinteger
Mindestschulstufe der Teilnehmenden.
max_grade_levelinteger
Maximale Klassenstufe der Teilnehmer.
age_toleranceinteger
Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
event_people_limitinteger
maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
event_people_min_limitinteger
minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
hide_event_people_limitboolean
eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
event_people_recovered_vaccinated_limitinteger
Maximale Anzahl genesener oder geimpfter Teilnehmer.
event_people_not_recovered_vaccinated_limitinteger
Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
has_wait_listboolean
Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
wait_list_confirmation_requiredboolean
Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
trial_enabledboolean
Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
can_sign_up_for_main_eventboolean
Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
only_sign_up_for_main_eventboolean
Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
sign_up_limit_days_beforeinteger
Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
sign_up_limit_stop_days_beforeinteger
Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
sign_up_delete_hours_beforeinteger
Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
start_timestring (date-time)
Beginn der Veranstaltung.
end_timestring (date-time)
Ende der Veranstaltung.
require_addressboolean
Teilnehmende müssen bei der Anmeldung eine Adresse angeben.
require_contactboolean
Teilnehmende müssen bei der Anmeldung Kontaktdaten angeben.
require_billingboolean
Teilnehmende müssen bei der Anmeldung Rechnungsdaten angeben.
allow_direct_billingboolean
require_direct_billingboolean
allow_budget_sign_upboolean
require_ageboolean
Teilnehmende müssen bei der Anmeldung ihr Alter angeben.
require_grade_levelboolean
Teilnehmende müssen bei der Anmeldung ihre Schulstufe angeben.
require_free_note_field_idsstring
IDs der Freitext-Notizfelder, die Teilnehmer ausfüllen müssen.
generate_new_bookingsboolean
Buchungen werden für den Veranstaltungsplan automatisch erzeugt.
generate_new_bookings_v2boolean
Buchungen werden mit der zweiten Version des Plan-Generators erzeugt.
generate_ignore_sys_calendarboolean
Erzeugte Buchungen ignorieren die Feiertage des Systemkalenders.
copy_main_sign_ups_to_bookingboolean
Anmeldungen der Hauptveranstaltung werden in die erzeugten Buchungen kopiert.
generate_hour_startstring (date-time)
Startzeit des Tages für erzeugte Buchungen.
generate_hour_endstring (date-time)
Endzeit des Tages für generierte Buchungen.
generate_day_of_weekinteger
Wochentag für erzeugte Buchungen.
bitmask_days_of_weekinteger
Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet
bitmask_hours_startinteger
Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt
summarized_date_timesstring
Zeichenkette mit den Wochentagen und Stunden, zu denen eine Veranstaltung beginnt
customer_detail_ctastring
In der Kunden-App auf der Veranstaltungsdetailseite angezeigter Call-to-Action-Text.
customer_badgestring
Badge-Text, der in der Kunden-App bei der Veranstaltung angezeigt wird.
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-Zeitnahme-Ergebnisse sind öffentlich.
timing_gps_trackingboolean
GPS-Tracking der Teilnehmer ist für die Zeitmessung aktiviert.
timing_self_check_inboolean
Teilnehmende können sich für die Zeitmessung selbst einchecken.
scoreboard_enabledboolean
Scoreboard (Spielstand und Spielbericht) für die Veranstaltung; die Einträge sind EventScoreboardActivity, aus denen der Spielstand berechnet wird.
scoreboard_sportstring
Sportart des Scoreboards (ScoreboardSportRules), bestimmt die möglichen Einträge.
scoreboard_home_namestring
Name des Heimteams auf der Anzeigetafel.
scoreboard_away_namestring
Name des Gastteams auf der Anzeigetafel.
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)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
addressstring
Adresse als Text.
address_streetstring
Straße der Adresse.
address_house_numberstring
Hausnummer der Adresse.
address_street_levelstring
Straße und Hausnummer der Adresse.
address_costring
Care-of-Zeile der Adresse.
address_citystring
Ort der Adresse.
address_zipstring
Postleitzahl der Adresse.
address_admin_level1string
Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
address_countrystring
Ländercode der Adresse.
… 20 weitere Felder

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_event \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://eure-instanz.iw-erp.de/api/event/base_event', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_event"

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://eure-instanz.iw-erp.de/api/event/base_event', [
  '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://eure-instanz.iw-erp.de/api/event/base_event"),
  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://eure-instanz.iw-erp.de/api/event/base_event")
  .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://eure-instanz.iw-erp.de/api/event/base_event"

	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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_event_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseEventController.getAll();
if (result.success) {
  print(result.data);
}

Antwort 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"
  }
]

BaseEvent neu anlegen

POST/api/event/base_event

Request-Body application/json

dataBaseEvent2
Felder anzeigen (31)
- moments_modestring
  Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
- moments_designstring
  Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
- public_subtitlestring
  Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
- billing_payment_profileBillingPaymentProfile17
  Zahlungsprofil, mit dem die Veranstaltung abgerechnet wird.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) für die Veranstaltung; die Einträge sind EventScoreboardActivity, aus denen der Spielstand berechnet wird.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die möglichen Einträge.
- scoreboard_home_namestring
  Name des Heimteams auf der Anzeigetafel.
- scoreboard_away_namestring
  Name des Gastteams auf der Anzeigetafel.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- highlightboolean
  Diese Eigenschaft markiert eine Entität als hervorgehoben
- ucatsarray<UnifiedCategory11>
  Vereinheitlichte Kategorien des Datensatzes.
- utagsarray<UnifiedTag4>
  Vereinheitlichte Tags des Datensatzes.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.

Antworten

200BaseEvent neu anlegenBaseEvent3

Felder anzeigen (36)

ticketSeatingPlanIdinteger
ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
secondaryBaseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
baseLocationBaseLocation8
Felder anzeigen (31)
- idinteger
  Primärschlüssel des Standorts. Interne ID.
- tokenstring
  Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.
- location_typestring
  Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.
- in_contact_centerboolean
  Der Standort wird im Kontaktcenter angezeigt.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- is_ui_filterboolean
  Diese Eigenschaft markiert eine Entität als Filter für das Frontend
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
idinteger
Primärschlüssel der Veranstaltung. Interne ID.
tokenstring
Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
moments_modestring
Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
moments_designstring
Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
public_keywordsstring
Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
public_subtitlestring
Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
event_typestring
Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
age_groupstring
Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
min_ageinteger
Mindestalter der Teilnehmenden in Jahren.
max_ageinteger
Maximales Alter der Teilnehmer in Jahren.
min_age_monthsinteger
Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
max_age_monthsinteger
Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
min_grade_levelinteger
Mindestschulstufe der Teilnehmenden.
max_grade_levelinteger
Maximale Klassenstufe der Teilnehmer.
age_toleranceinteger
Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
event_people_limitinteger
maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
event_people_min_limitinteger
minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
hide_event_people_limitboolean
eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
event_people_recovered_vaccinated_limitinteger
Maximale Anzahl genesener oder geimpfter Teilnehmer.
event_people_not_recovered_vaccinated_limitinteger
Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
has_wait_listboolean
Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
wait_list_confirmation_requiredboolean
Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
trial_enabledboolean
Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
can_sign_up_for_main_eventboolean
Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
only_sign_up_for_main_eventboolean
Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
sign_up_limit_days_beforeinteger
Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
sign_up_limit_stop_days_beforeinteger
Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
sign_up_delete_hours_beforeinteger
Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
performing_personCRMPerson49
CRM-Person, die die Veranstaltung leitet, zum Beispiel der Trainer.
Felder anzeigen (31)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- … 54 weitere Felder
… 78 weitere Felder

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/base_event \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "scoreboard_home_name": "Beispiel",
    "scoreboard_away_name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      scoreboard_home_name: 'Beispiel',
      scoreboard_away_name: 'Beispiel',
      address_street: 'Jakobistr. 39',
      address_city: 'Hannover',
      address_zip: '30163',
      address_country: 'DE'
    }
  })
};

fetch('https://eure-instanz.iw-erp.de/api/event/base_event', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_event"

payload = { "data": {
    "scoreboard_home_name": "Beispiel",
    "scoreboard_away_name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/event/base_event', [
  'body' => '{"data":{"scoreboard_home_name":"Beispiel","scoreboard_away_name":"Beispiel","address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163","address_country":"DE"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/event/base_event"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"scoreboard_home_name\":\"Beispiel\",\"scoreboard_away_name\":\"Beispiel\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"scoreboard_home_name\":\"Beispiel\",\"scoreboard_away_name\":\"Beispiel\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/event/base_event")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/event/base_event"

	payload := strings.NewReader("{\"data\":{\"scoreboard_home_name\":\"Beispiel\",\"scoreboard_away_name\":\"Beispiel\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\"}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

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

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

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_event_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseEventController.post(EventBaseEvent.fromJson({
  "scoreboard_home_name": "Beispiel",
  "scoreboard_away_name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE"
}));
if (result.success) {
  print(result.data);
}

Antwort 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"
}

Liefert ein einzelnes BaseEvent-Objekt mit der angegebenen ID oder dem angegebenen Token.

GET/api/event/base_event/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes BaseEvent-Objekt mit der angegebenen ID oder dem angegebenen Token.BaseEvent3

Felder anzeigen (36)

ticketSeatingPlanIdinteger
ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
secondaryBaseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
baseLocationBaseLocation8
Felder anzeigen (31)
- idinteger
  Primärschlüssel des Standorts. Interne ID.
- tokenstring
  Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.
- location_typestring
  Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.
- in_contact_centerboolean
  Der Standort wird im Kontaktcenter angezeigt.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- is_ui_filterboolean
  Diese Eigenschaft markiert eine Entität als Filter für das Frontend
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
idinteger
Primärschlüssel der Veranstaltung. Interne ID.
tokenstring
Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
moments_modestring
Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
moments_designstring
Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
public_keywordsstring
Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
public_subtitlestring
Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
event_typestring
Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
age_groupstring
Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
min_ageinteger
Mindestalter der Teilnehmenden in Jahren.
max_ageinteger
Maximales Alter der Teilnehmer in Jahren.
min_age_monthsinteger
Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
max_age_monthsinteger
Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
min_grade_levelinteger
Mindestschulstufe der Teilnehmenden.
max_grade_levelinteger
Maximale Klassenstufe der Teilnehmer.
age_toleranceinteger
Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
event_people_limitinteger
maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
event_people_min_limitinteger
minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
hide_event_people_limitboolean
eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
event_people_recovered_vaccinated_limitinteger
Maximale Anzahl genesener oder geimpfter Teilnehmer.
event_people_not_recovered_vaccinated_limitinteger
Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
has_wait_listboolean
Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
wait_list_confirmation_requiredboolean
Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
trial_enabledboolean
Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
can_sign_up_for_main_eventboolean
Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
only_sign_up_for_main_eventboolean
Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
sign_up_limit_days_beforeinteger
Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
sign_up_limit_stop_days_beforeinteger
Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
sign_up_delete_hours_beforeinteger
Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
performing_personCRMPerson49
CRM-Person, die die Veranstaltung leitet, zum Beispiel der Trainer.
Felder anzeigen (31)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- … 54 weitere Felder
… 78 weitere Felder

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_event/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

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

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

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_event/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://eure-instanz.iw-erp.de/api/event/base_event/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://eure-instanz.iw-erp.de/api/event/base_event/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://eure-instanz.iw-erp.de/api/event/base_event/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://eure-instanz.iw-erp.de/api/event/base_event/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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_event_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseEventController.get('42');
if (result.success) {
  print(result.data);
}

Antwort 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"
}

BaseEvent aktualisieren

PUT/api/event/base_event/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

dataBaseEvent2
Felder anzeigen (31)
- moments_modestring
  Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
- moments_designstring
  Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
- public_subtitlestring
  Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
- billing_payment_profileBillingPaymentProfile17
  Zahlungsprofil, mit dem die Veranstaltung abgerechnet wird.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) für die Veranstaltung; die Einträge sind EventScoreboardActivity, aus denen der Spielstand berechnet wird.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die möglichen Einträge.
- scoreboard_home_namestring
  Name des Heimteams auf der Anzeigetafel.
- scoreboard_away_namestring
  Name des Gastteams auf der Anzeigetafel.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- highlightboolean
  Diese Eigenschaft markiert eine Entität als hervorgehoben
- ucatsarray<UnifiedCategory11>
  Vereinheitlichte Kategorien des Datensatzes.
- utagsarray<UnifiedTag4>
  Vereinheitlichte Tags des Datensatzes.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.

Antworten

200BaseEvent aktualisierenBaseEvent3

Felder anzeigen (36)

ticketSeatingPlanIdinteger
ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
secondaryBaseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
baseLocationBaseLocation8
Felder anzeigen (31)
- idinteger
  Primärschlüssel des Standorts. Interne ID.
- tokenstring
  Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.
- location_typestring
  Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.
- in_contact_centerboolean
  Der Standort wird im Kontaktcenter angezeigt.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- is_ui_filterboolean
  Diese Eigenschaft markiert eine Entität als Filter für das Frontend
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
idinteger
Primärschlüssel der Veranstaltung. Interne ID.
tokenstring
Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
moments_modestring
Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
moments_designstring
Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
public_keywordsstring
Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
public_subtitlestring
Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
event_typestring
Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
age_groupstring
Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
min_ageinteger
Mindestalter der Teilnehmenden in Jahren.
max_ageinteger
Maximales Alter der Teilnehmer in Jahren.
min_age_monthsinteger
Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
max_age_monthsinteger
Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
min_grade_levelinteger
Mindestschulstufe der Teilnehmenden.
max_grade_levelinteger
Maximale Klassenstufe der Teilnehmer.
age_toleranceinteger
Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
event_people_limitinteger
maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
event_people_min_limitinteger
minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
hide_event_people_limitboolean
eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
event_people_recovered_vaccinated_limitinteger
Maximale Anzahl genesener oder geimpfter Teilnehmer.
event_people_not_recovered_vaccinated_limitinteger
Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
has_wait_listboolean
Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
wait_list_confirmation_requiredboolean
Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
trial_enabledboolean
Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
can_sign_up_for_main_eventboolean
Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
only_sign_up_for_main_eventboolean
Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
sign_up_limit_days_beforeinteger
Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
sign_up_limit_stop_days_beforeinteger
Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
sign_up_delete_hours_beforeinteger
Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
performing_personCRMPerson49
CRM-Person, die die Veranstaltung leitet, zum Beispiel der Trainer.
Felder anzeigen (31)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- … 54 weitere Felder
… 78 weitere Felder

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/event/base_event/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "scoreboard_home_name": "Beispiel",
    "scoreboard_away_name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      scoreboard_home_name: 'Beispiel',
      scoreboard_away_name: 'Beispiel',
      address_street: 'Jakobistr. 39',
      address_city: 'Hannover',
      address_zip: '30163',
      address_country: 'DE'
    }
  })
};

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

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_event/42"

payload = { "data": {
    "scoreboard_home_name": "Beispiel",
    "scoreboard_away_name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://eure-instanz.iw-erp.de/api/event/base_event/42', [
  'body' => '{"data":{"scoreboard_home_name":"Beispiel","scoreboard_away_name":"Beispiel","address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163","address_country":"DE"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/event/base_event/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"scoreboard_home_name\":\"Beispiel\",\"scoreboard_away_name\":\"Beispiel\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"scoreboard_home_name\":\"Beispiel\",\"scoreboard_away_name\":\"Beispiel\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/event/base_event/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/event/base_event/42"

	payload := strings.NewReader("{\"data\":{\"scoreboard_home_name\":\"Beispiel\",\"scoreboard_away_name\":\"Beispiel\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\"}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

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

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

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_event_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_event.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseEventController.put(EventBaseEvent.fromJson({
  "scoreboard_home_name": "Beispiel",
  "scoreboard_away_name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE"
}));
if (result.success) {
  print(result.data);
}

Antwort 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"
}

BaseEvent aktualisieren

PATCH/api/event/base_event/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

dataBaseEvent2
Felder anzeigen (31)
- moments_modestring
  Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
- moments_designstring
  Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
- public_subtitlestring
  Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
- billing_payment_profileBillingPaymentProfile17
  Zahlungsprofil, mit dem die Veranstaltung abgerechnet wird.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) für die Veranstaltung; die Einträge sind EventScoreboardActivity, aus denen der Spielstand berechnet wird.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die möglichen Einträge.
- scoreboard_home_namestring
  Name des Heimteams auf der Anzeigetafel.
- scoreboard_away_namestring
  Name des Gastteams auf der Anzeigetafel.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- highlightboolean
  Diese Eigenschaft markiert eine Entität als hervorgehoben
- ucatsarray<UnifiedCategory11>
  Vereinheitlichte Kategorien des Datensatzes.
- utagsarray<UnifiedTag4>
  Vereinheitlichte Tags des Datensatzes.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.

Antworten

200BaseEvent aktualisierenBaseEvent3

Felder anzeigen (36)

ticketSeatingPlanIdinteger
ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
secondaryBaseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
baseLocationBaseLocation8
Felder anzeigen (31)
- idinteger
  Primärschlüssel des Standorts. Interne ID.
- tokenstring
  Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.
- location_typestring
  Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.
- in_contact_centerboolean
  Der Standort wird im Kontaktcenter angezeigt.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- is_ui_filterboolean
  Diese Eigenschaft markiert eine Entität als Filter für das Frontend
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
idinteger
Primärschlüssel der Veranstaltung. Interne ID.
tokenstring
Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
moments_modestring
Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
moments_designstring
Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
public_keywordsstring
Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
public_subtitlestring
Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
event_typestring
Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
age_groupstring
Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
min_ageinteger
Mindestalter der Teilnehmenden in Jahren.
max_ageinteger
Maximales Alter der Teilnehmer in Jahren.
min_age_monthsinteger
Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
max_age_monthsinteger
Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
min_grade_levelinteger
Mindestschulstufe der Teilnehmenden.
max_grade_levelinteger
Maximale Klassenstufe der Teilnehmer.
age_toleranceinteger
Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
event_people_limitinteger
maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
event_people_min_limitinteger
minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
hide_event_people_limitboolean
eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
event_people_recovered_vaccinated_limitinteger
Maximale Anzahl genesener oder geimpfter Teilnehmer.
event_people_not_recovered_vaccinated_limitinteger
Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
has_wait_listboolean
Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
wait_list_confirmation_requiredboolean
Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
trial_enabledboolean
Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
can_sign_up_for_main_eventboolean
Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
only_sign_up_for_main_eventboolean
Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
sign_up_limit_days_beforeinteger
Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
sign_up_limit_stop_days_beforeinteger
Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
sign_up_delete_hours_beforeinteger
Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
performing_personCRMPerson49
CRM-Person, die die Veranstaltung leitet, zum Beispiel der Trainer.
Felder anzeigen (31)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- … 54 weitere Felder
… 78 weitere Felder

Anfrage

curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/event/base_event/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "scoreboard_home_name": "Beispiel",
    "scoreboard_away_name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      scoreboard_home_name: 'Beispiel',
      scoreboard_away_name: 'Beispiel',
      address_street: 'Jakobistr. 39',
      address_city: 'Hannover',
      address_zip: '30163',
      address_country: 'DE'
    }
  })
};

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

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_event/42"

payload = { "data": {
    "scoreboard_home_name": "Beispiel",
    "scoreboard_away_name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://eure-instanz.iw-erp.de/api/event/base_event/42', [
  'body' => '{"data":{"scoreboard_home_name":"Beispiel","scoreboard_away_name":"Beispiel","address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163","address_country":"DE"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/event/base_event/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"scoreboard_home_name\":\"Beispiel\",\"scoreboard_away_name\":\"Beispiel\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"scoreboard_home_name\":\"Beispiel\",\"scoreboard_away_name\":\"Beispiel\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/event/base_event/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/event/base_event/42"

	payload := strings.NewReader("{\"data\":{\"scoreboard_home_name\":\"Beispiel\",\"scoreboard_away_name\":\"Beispiel\",\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\"}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

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

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

	fmt.Println(string(body))

}

Dart mit package:http (kein Controller im Package iw_erp_api)

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

final response = await http.patch(
  Uri.parse('https://eure-instanz.iw-erp.de/api/event/base_event/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "scoreboard_home_name": "Beispiel",
      "scoreboard_away_name": "Beispiel",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE"
    }
  }),
);
print(response.body);

Antwort 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"
}

Diese Methode liefert alle BaseEvent-Objekte für Kunden

GET/api/event/base_event_customer

Query-Parameter

`name`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`token`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`baseLocation`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`baseBookable`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`secondaryBaseBookable`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`eventType`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`ageGroup`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`processedMinAge`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`processedMaxAge`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`generateDayOfWeek`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`bitmaskDaysOfWeek`string	Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet \| Benötigtes Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`bitmaskHoursStart`string	Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt \| Benötigtes Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`orderStringOne`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`orderStringTwo`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`orderWeekday`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`orderWeekdayOngoing`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`startTime`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`endTime`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`slugIdentifier`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`created`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`updated`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`minGradeLevel`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`maxGradeLevel`string	Erfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`highlight`boolean	Diese Eigenschaft markiert eine Entität als hervorgehoben \| Benötigtes Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`trialEnabled`boolean	Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel. \| Benötigt Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
`deleted`boolean	Diese Eigenschaft markiert eine Entität als gelöscht / archiviert \| Benötigtes Zugriffsrecht: SCOPE
`requireAge`boolean
`requireGradeLevel`boolean
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der BaseEvent-Objekte für Kunden.array<BaseEvent3>

Felder anzeigen (36)

ticketSeatingPlanIdinteger
ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
secondaryBaseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
baseLocationBaseLocation8
Felder anzeigen (31)
- idinteger
  Primärschlüssel des Standorts. Interne ID.
- tokenstring
  Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.
- location_typestring
  Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.
- in_contact_centerboolean
  Der Standort wird im Kontaktcenter angezeigt.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- is_ui_filterboolean
  Diese Eigenschaft markiert eine Entität als Filter für das Frontend
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
idinteger
Primärschlüssel der Veranstaltung. Interne ID.
tokenstring
Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
moments_modestring
Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
moments_designstring
Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
public_keywordsstring
Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
public_subtitlestring
Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
event_typestring
Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
age_groupstring
Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
min_ageinteger
Mindestalter der Teilnehmenden in Jahren.
max_ageinteger
Maximales Alter der Teilnehmer in Jahren.
min_age_monthsinteger
Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
max_age_monthsinteger
Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
min_grade_levelinteger
Mindestschulstufe der Teilnehmenden.
max_grade_levelinteger
Maximale Klassenstufe der Teilnehmer.
age_toleranceinteger
Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
event_people_limitinteger
maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
event_people_min_limitinteger
minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
hide_event_people_limitboolean
eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
event_people_recovered_vaccinated_limitinteger
Maximale Anzahl genesener oder geimpfter Teilnehmer.
event_people_not_recovered_vaccinated_limitinteger
Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
has_wait_listboolean
Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
wait_list_confirmation_requiredboolean
Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
trial_enabledboolean
Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
can_sign_up_for_main_eventboolean
Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
only_sign_up_for_main_eventboolean
Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
sign_up_limit_days_beforeinteger
Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
sign_up_limit_stop_days_beforeinteger
Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
sign_up_delete_hours_beforeinteger
Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
performing_personCRMPerson49
CRM-Person, die die Veranstaltung leitet, zum Beispiel der Trainer.
Felder anzeigen (31)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- … 54 weitere Felder
… 78 weitere Felder

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_event_customer \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://eure-instanz.iw-erp.de/api/event/base_event_customer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_event_customer"

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://eure-instanz.iw-erp.de/api/event/base_event_customer', [
  '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://eure-instanz.iw-erp.de/api/event/base_event_customer"),
  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://eure-instanz.iw-erp.de/api/event/base_event_customer")
  .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://eure-instanz.iw-erp.de/api/event/base_event_customer"

	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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_event_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseEventController.getAllCustomer();
if (result.success) {
  print(result.data);
}

Antwort 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"
  }
]

Diese Methode liefert Buchungen für eine BaseEvent mit der angegebenen ID oder dem Token

GET/api/event/base_event_base_booking/{identifier}

Pfad-Parameter

identifierPflichtstring

Query-Parameter

`deleted`boolean	Diese Eigenschaft markiert eine Entität als gelöscht / archiviert \| Benötigtes Zugriffsrecht: PUBLIC_LIST
`baseLocation`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`baseEvent`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`baseBookable`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`secondaryBaseBookable`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`baseBookable---secondaryBaseBookable`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`user`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`startTime`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`endTime`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`color`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`billed`boolean	Erfordert Zugriffsrecht: PUBLIC_LIST
`waiting`boolean	Erfordert Zugriffsrecht: PUBLIC_LIST
`bookingType`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`contentType`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`bookingStatus`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`addonData_publicDeleted`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`addonData_addressAutoCompleteType`string	Erfordert Zugriffsrecht: PUBLIC_LIST
`eventType`string	denormalisierter Veranstaltungstyp aus BaseEvent für schnelle Filterung \| Erforderliches Zugriffsrecht: PUBLIC_LIST
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der BaseBooking-Objekte für die angegebene Veranstaltung.array<BaseBooking2>

Felder anzeigen (5)

baseLocationBaseLocation10
Felder anzeigen (29)
- idinteger
  Primärschlüssel des Standorts. Interne ID.
- tokenstring
  Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.
- location_typestring
  Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.
- in_contact_centerboolean
  Der Standort wird im Kontaktcenter angezeigt.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- is_ui_filterboolean
  Diese Eigenschaft markiert eine Entität als Filter für das Frontend
baseBookableBaseBookable10
Felder anzeigen (50)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation10
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
secondaryBaseBookableBaseBookable10
Felder anzeigen (50)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation10
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
baseEventBaseEvent13
Felder anzeigen (68)
- ticketSeatingPlanIdinteger
  ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
- bib_numbers_enabledboolean
- timing_enabledboolean
- baseBookableBaseBookable10
- secondaryBaseBookableBaseBookable10
- baseLocationBaseLocation10
- idinteger
  Primärschlüssel der Veranstaltung. Interne ID.
- tokenstring
  Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
- moments_modestring
  Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
- moments_designstring
  Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
- public_keywordsstring
  Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
- public_subtitlestring
  Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
- event_typestring
  Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
- age_groupstring
  Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
- min_ageinteger
  Mindestalter der Teilnehmenden in Jahren.
- max_ageinteger
  Maximales Alter der Teilnehmer in Jahren.
- min_age_monthsinteger
  Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
- max_age_monthsinteger
  Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
- min_grade_levelinteger
  Mindestschulstufe der Teilnehmenden.
- max_grade_levelinteger
  Maximale Klassenstufe der Teilnehmer.
- age_toleranceinteger
  Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
- event_people_limitinteger
  maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
- event_people_min_limitinteger
  minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
- hide_event_people_limitboolean
  eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
- event_people_recovered_vaccinated_limitinteger
  Maximale Anzahl genesener oder geimpfter Teilnehmer.
- event_people_not_recovered_vaccinated_limitinteger
  Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
- has_wait_listboolean
  Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
- wait_list_confirmation_requiredboolean
  Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
- trial_enabledboolean
  Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
- can_sign_up_for_main_eventboolean
  Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
- only_sign_up_for_main_eventboolean
  Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
- sign_up_limit_days_beforeinteger
  Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
- sign_up_limit_stop_days_beforeinteger
  Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
- sign_up_delete_hours_beforeinteger
  Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
- performing_personCRMPerson10
  CRM-Person, die die Veranstaltung leitet, zum Beispiel der Trainer.
- secondary_performing_personCRMPerson10
  Zweite CRM-Person, die die Veranstaltung leitet.
- start_timestring (date-time)
  Beginn der Veranstaltung.
- end_timestring (date-time)
  Ende der Veranstaltung.
- require_addressboolean
  Teilnehmende müssen bei der Anmeldung eine Adresse angeben.
- require_contactboolean
  Teilnehmende müssen bei der Anmeldung Kontaktdaten angeben.
- require_billingboolean
  Teilnehmende müssen bei der Anmeldung Rechnungsdaten angeben.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Teilnehmende müssen bei der Anmeldung ihr Alter angeben.
- require_grade_levelboolean
  Teilnehmende müssen bei der Anmeldung ihre Schulstufe angeben.
- require_free_note_field_idsstring
  IDs der Freitext-Notizfelder, die Teilnehmer ausfüllen müssen.
- generate_new_bookingsboolean
  Buchungen werden für den Veranstaltungsplan automatisch erzeugt.
- generate_new_bookings_v2boolean
  Buchungen werden mit der zweiten Version des Plan-Generators erzeugt.
- generate_ignore_sys_calendarboolean
  Erzeugte Buchungen ignorieren die Feiertage des Systemkalenders.
- copy_main_sign_ups_to_bookingboolean
  Anmeldungen der Hauptveranstaltung werden in die erzeugten Buchungen kopiert.
- generate_hour_startstring (date-time)
  Startzeit des Tages für erzeugte Buchungen.
- generate_hour_endstring (date-time)
  Endzeit des Tages für generierte Buchungen.
- generate_day_of_weekinteger
  Wochentag für erzeugte Buchungen.
- bitmask_days_of_weekinteger
  Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet
- bitmask_hours_startinteger
  Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt
- summarized_date_timesstring
  Zeichenkette mit den Wochentagen und Stunden, zu denen eine Veranstaltung beginnt
- customer_detail_ctastring
  In der Kunden-App auf der Veranstaltungsdetailseite angezeigter Call-to-Action-Text.
- customer_badgestring
  Badge-Text, der in der Kunden-App bei der Veranstaltung angezeigt wird.
- 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-Zeitnahme-Ergebnisse sind öffentlich.
- timing_gps_trackingboolean
  GPS-Tracking der Teilnehmer ist für die Zeitmessung aktiviert.
- timing_self_check_inboolean
  Teilnehmende können sich für die Zeitmessung selbst einchecken.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) für die Veranstaltung; die Einträge sind EventScoreboardActivity, aus denen der Spielstand berechnet wird.
- … 37 weitere Felder
… 42 weitere Felder

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_event_base_booking/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

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

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

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_event_base_booking/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://eure-instanz.iw-erp.de/api/event/base_event_base_booking/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://eure-instanz.iw-erp.de/api/event/base_event_base_booking/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://eure-instanz.iw-erp.de/api/event/base_event_base_booking/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://eure-instanz.iw-erp.de/api/event/base_event_base_booking/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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_event_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseEventController.getBookings('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Liefert ein einzelnes hervorgehobenes BaseEvent-Objekt. Passen mehrere hervorgehobene Veranstaltungen zur Abfrage, wird eine davon zufällig ausgewählt. Das Ergebnis wird 10 Minuten zwischengespeichert.

GET/api/event/base_event_highlight

Query-Parameter

`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert ein einzelnes hervorgehobenes BaseEvent-Objekt.BaseEvent3

Felder anzeigen (36)

ticketSeatingPlanIdinteger
ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
secondaryBaseBookableBaseBookable9
Felder anzeigen (52)
- ticketSeatingPlanIdinteger
  ID des Platzplans des Raums, auch für die öffentliche Serialisierung.
- baseLocationBaseLocation8
- idinteger
  Primärschlüssel der buchbaren Ressource. Interne ID.
- tokenstring
  Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.
- bookable_typestring
  Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.
- floor_levelstring
  Etage, auf der das Buchbare liegt.
- floor_sizeinteger
  Grundfläche in Quadratmetern.
- pets_allowedboolean
  Haustiere sind erlaubt.
- barrier_freeboolean
  Der Buchungsgegenstand ist barrierefrei.
- cargo_volumeinteger
  Ladevolumen in Litern.
- fuel_typestring
  Kraftstoffart des Fahrzeugs.
- seating_capacityinteger
  Anzahl der Plätze.
- has_wait_listboolean
  Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.
- booking_limitinteger
  Maximale Anzahl Buchungen.
- billing_modestring
  Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.
- max_active_bookings_per_userinteger
  Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- max_advance_booking_hoursinteger
  Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.
- inventory_managedboolean
  Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.
- inventory_depositnumber (float)
  Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.
- require_addressboolean
  Die Adresse muss bei der Buchung eingegeben werden.
- require_contactboolean
  Kontaktdaten müssen bei der Buchung eingegeben werden.
- require_billingboolean
  Beim Buchen müssen Abrechnungsdaten eingegeben werden.
- require_booking_titleboolean
  Beim Buchen muss ein Titel eingegeben werden.
- allow_direct_billingboolean
- require_ageboolean
  Das Alter muss bei der Buchung eingegeben werden.
- counter_update_modestring
  Wie die Nutzungszähler des Buchbaren aktualisiert werden.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
baseLocationBaseLocation8
Felder anzeigen (31)
- idinteger
  Primärschlüssel des Standorts. Interne ID.
- tokenstring
  Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.
- location_typestring
  Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.
- in_contact_centerboolean
  Der Standort wird im Kontaktcenter angezeigt.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- short_identifierstring
  Kurzkennung der Entität.
- image_urlstring
  URL des Bildes des Datensatzes.
- slug_identifierstring
  Slug, der in URLs der Entität verwendet wird.
- is_ui_filterboolean
  Diese Eigenschaft markiert eine Entität als Filter für das Frontend
- unified_cat_idsobject
  IDs der vereinheitlichten Kategorien.
- unified_cat_namesobject
  Namen der vereinheitlichten Kategorien.
idinteger
Primärschlüssel der Veranstaltung. Interne ID.
tokenstring
Öffentlicher Token der Veranstaltung. In Links und QR-Codes anstelle der ID verwendet.
moments_modestring
Steuert die Funktion Veranstaltungsmomente (digitales Gästebuch): DISABLED = Funktion aus, PARTICIPANTS_ONLY = nur über teilnehmergebundene Momenten-Token, ALL = zusätzlich über das anonyme Momenten-Token der Veranstaltung zugänglich
moments_designstring
Visuelles Design der Momente-Seiten (digitales Gästebuch) und Exporte.
public_keywordsstring
Schlüsselwörter, die in der öffentlichen Event-Liste angezeigt werden.
public_subtitlestring
Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.
event_typestring
Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.
age_groupstring
Altersgruppe, für die die Veranstaltung gedacht ist, zum Beispiel Kinder oder Erwachsene.
min_ageinteger
Mindestalter der Teilnehmenden in Jahren.
max_ageinteger
Maximales Alter der Teilnehmer in Jahren.
min_age_monthsinteger
Mindestalter der Teilnehmenden in Monaten, für Veranstaltungen für Säuglinge.
max_age_monthsinteger
Maximales Alter der Teilnehmer in Monaten, für Events für Säuglinge.
min_grade_levelinteger
Mindestschulstufe der Teilnehmenden.
max_grade_levelinteger
Maximale Klassenstufe der Teilnehmer.
age_toleranceinteger
Jahre, um die Teilnehmende außerhalb der Altersspanne liegen dürfen und sich dennoch anmelden können.
event_people_limitinteger
maximale Anzahl Personen, die an der Veranstaltung teilnehmen können
event_people_min_limitinteger
minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen
hide_event_people_limitboolean
eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden
event_people_recovered_vaccinated_limitinteger
Maximale Anzahl genesener oder geimpfter Teilnehmer.
event_people_not_recovered_vaccinated_limitinteger
Maximale Anzahl Teilnehmer, die weder genesen noch geimpft sind.
has_wait_listboolean
Die Veranstaltung hat eine Warteliste, sobald sie voll ist.
wait_list_confirmation_requiredboolean
Teilnehmende von der Warteliste müssen ihren Platz bestätigen.
trial_enabledboolean
Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.
can_sign_up_for_main_eventboolean
Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.
only_sign_up_for_main_eventboolean
Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.
sign_up_limit_days_beforeinteger
Anzahl der Tage vor dem Beginn, bis zu denen Anmeldungen möglich sind.
sign_up_limit_stop_days_beforeinteger
Anzahl der Tage vor dem Beginn, ab denen Anmeldungen geschlossen sind.
sign_up_delete_hours_beforeinteger
Stunden vor Beginn, bis zu denen ein Teilnehmer die Anmeldung stornieren kann.
performing_personCRMPerson49
CRM-Person, die die Veranstaltung leitet, zum Beispiel der Trainer.
Felder anzeigen (31)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- … 54 weitere Felder
… 78 weitere Felder

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_event_highlight \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://eure-instanz.iw-erp.de/api/event/base_event_highlight', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_event_highlight"

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://eure-instanz.iw-erp.de/api/event/base_event_highlight', [
  '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://eure-instanz.iw-erp.de/api/event/base_event_highlight"),
  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://eure-instanz.iw-erp.de/api/event/base_event_highlight")
  .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://eure-instanz.iw-erp.de/api/event/base_event_highlight"

	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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_event_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseEventController.getHighlight();
if (result.success) {
  print(result.data);
}

Antwort 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"
}