Event

Events8 EndpointsEvent / Event

Returns a list of events

GET/api/event/base_event

Query parameters

`name`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`token`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseLocation`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseBookable`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`secondaryBaseBookable`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`eventType`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`ageGroup`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`processedMinAge`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`processedMaxAge`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`generateDayOfWeek`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`bitmaskDaysOfWeek`string	This is a bitmask value of the days of the week the event occurs on \| Requires access right: PUBLIC, LOGGED_IN, SCOPE
`bitmaskHoursStart`string	This is a bitmask value of the hours an event starts on \| Requires access right: PUBLIC, LOGGED_IN, SCOPE
`orderStringOne`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`orderStringTwo`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`orderWeekday`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`orderWeekdayOngoing`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`startTime`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`endTime`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`slugIdentifier`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`created`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`updated`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`minGradeLevel`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`maxGradeLevel`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`highlight`boolean	This property is used to mark an entity as highlighted \| Requires access right: PUBLIC, LOGGED_IN, SCOPE
`trialEnabled`boolean	Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule. \| Requires access right: PUBLIC, LOGGED_IN, SCOPE
`deleted`boolean	This property is used to mark an entity as deleted / archived
`requireAge`boolean
`requireGradeLevel`boolean
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of eventsarray<BaseEvent>

Show fields (81)

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

Request

curl --request GET \
  --url https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with the iw_erp_api package

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

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

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

Response 200 application/json

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

Add a new BaseEvent

POST/api/event/base_event

Request body application/json

dataBaseEvent2
Show fields (31)
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_subtitlestring
  Subtitle shown in the public event listing.
- billing_payment_profileBillingPaymentProfile17
  Payment profile used for billing the event.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- highlightboolean
  This property is used to mark an entity as highlighted
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.
- utagsarray<UnifiedTag4>
  Unified tags of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.

Responses

200Add a new BaseEventBaseEvent3

Show fields (36)

ticketSeatingPlanIdinteger
Id of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
secondaryBaseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
baseLocationBaseLocation8
Show fields (31)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the event. Internal ID.
tokenstring
Public token of the event. Used in links and QR codes instead of the ID.
moments_modestring
Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
moments_designstring
Visual theme of the moments (digital guestbook) pages and exports.
public_keywordsstring
Keywords shown in the public event listing.
public_subtitlestring
Subtitle shown in the public event listing.
event_typestring
Type of the event, for example course, trip or tournament.
age_groupstring
Age group the event is intended for, for example children or adults.
min_ageinteger
Minimum age in years of participants.
max_ageinteger
Maximum age in years of participants.
min_age_monthsinteger
Minimum age in months of participants, for events for infants.
max_age_monthsinteger
Maximum age in months of participants, for events for infants.
min_grade_levelinteger
Minimum school grade level of participants.
max_grade_levelinteger
Maximum school grade level of participants.
age_toleranceinteger
Years by which participants may be outside the age range and still sign up.
event_people_limitinteger
maximum number of people that can attend the event
event_people_min_limitinteger
minimum number of people that must attend the event
hide_event_people_limitboolean
a setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitinteger
Maximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitinteger
Maximum number of participants who are neither recovered nor vaccinated.
has_wait_listboolean
The event has a waiting list once it is full.
wait_list_confirmation_requiredboolean
Participants from the waiting list must confirm their place.
trial_enabledboolean
Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
can_sign_up_for_main_eventboolean
Participants may sign up for the main event.
only_sign_up_for_main_eventboolean
Participants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeinteger
Number of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeinteger
Number of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeinteger
Hours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson49
CRM person who leads the event, for example the trainer.
Show fields (31)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- … 54 more fields
… 78 more fields

Request

curl --request POST \
  --url https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with the iw_erp_api package

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 = 'your-instance.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);
}

Response 200 application/json

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

Returns a single BaseEvent with the given id or token

GET/api/event/base_event/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single BaseEvent with the given id or tokenBaseEvent3

Show fields (36)

ticketSeatingPlanIdinteger
Id of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
secondaryBaseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
baseLocationBaseLocation8
Show fields (31)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the event. Internal ID.
tokenstring
Public token of the event. Used in links and QR codes instead of the ID.
moments_modestring
Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
moments_designstring
Visual theme of the moments (digital guestbook) pages and exports.
public_keywordsstring
Keywords shown in the public event listing.
public_subtitlestring
Subtitle shown in the public event listing.
event_typestring
Type of the event, for example course, trip or tournament.
age_groupstring
Age group the event is intended for, for example children or adults.
min_ageinteger
Minimum age in years of participants.
max_ageinteger
Maximum age in years of participants.
min_age_monthsinteger
Minimum age in months of participants, for events for infants.
max_age_monthsinteger
Maximum age in months of participants, for events for infants.
min_grade_levelinteger
Minimum school grade level of participants.
max_grade_levelinteger
Maximum school grade level of participants.
age_toleranceinteger
Years by which participants may be outside the age range and still sign up.
event_people_limitinteger
maximum number of people that can attend the event
event_people_min_limitinteger
minimum number of people that must attend the event
hide_event_people_limitboolean
a setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitinteger
Maximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitinteger
Maximum number of participants who are neither recovered nor vaccinated.
has_wait_listboolean
The event has a waiting list once it is full.
wait_list_confirmation_requiredboolean
Participants from the waiting list must confirm their place.
trial_enabledboolean
Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
can_sign_up_for_main_eventboolean
Participants may sign up for the main event.
only_sign_up_for_main_eventboolean
Participants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeinteger
Number of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeinteger
Number of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeinteger
Hours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson49
CRM person who leads the event, for example the trainer.
Show fields (31)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- … 54 more fields
… 78 more fields

Request

curl --request GET \
  --url https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with the iw_erp_api package

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

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

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

Response 200 application/json

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

Update a BaseEvent

PUT/api/event/base_event/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataBaseEvent2
Show fields (31)
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_subtitlestring
  Subtitle shown in the public event listing.
- billing_payment_profileBillingPaymentProfile17
  Payment profile used for billing the event.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- highlightboolean
  This property is used to mark an entity as highlighted
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.
- utagsarray<UnifiedTag4>
  Unified tags of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.

Responses

200Update a BaseEventBaseEvent3

Show fields (36)

ticketSeatingPlanIdinteger
Id of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
secondaryBaseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
baseLocationBaseLocation8
Show fields (31)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the event. Internal ID.
tokenstring
Public token of the event. Used in links and QR codes instead of the ID.
moments_modestring
Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
moments_designstring
Visual theme of the moments (digital guestbook) pages and exports.
public_keywordsstring
Keywords shown in the public event listing.
public_subtitlestring
Subtitle shown in the public event listing.
event_typestring
Type of the event, for example course, trip or tournament.
age_groupstring
Age group the event is intended for, for example children or adults.
min_ageinteger
Minimum age in years of participants.
max_ageinteger
Maximum age in years of participants.
min_age_monthsinteger
Minimum age in months of participants, for events for infants.
max_age_monthsinteger
Maximum age in months of participants, for events for infants.
min_grade_levelinteger
Minimum school grade level of participants.
max_grade_levelinteger
Maximum school grade level of participants.
age_toleranceinteger
Years by which participants may be outside the age range and still sign up.
event_people_limitinteger
maximum number of people that can attend the event
event_people_min_limitinteger
minimum number of people that must attend the event
hide_event_people_limitboolean
a setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitinteger
Maximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitinteger
Maximum number of participants who are neither recovered nor vaccinated.
has_wait_listboolean
The event has a waiting list once it is full.
wait_list_confirmation_requiredboolean
Participants from the waiting list must confirm their place.
trial_enabledboolean
Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
can_sign_up_for_main_eventboolean
Participants may sign up for the main event.
only_sign_up_for_main_eventboolean
Participants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeinteger
Number of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeinteger
Number of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeinteger
Hours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson49
CRM person who leads the event, for example the trainer.
Show fields (31)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- … 54 more fields
… 78 more fields

Request

curl --request PUT \
  --url https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with the iw_erp_api package

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 = 'your-instance.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);
}

Response 200 application/json

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

Update a BaseEvent

PATCH/api/event/base_event/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataBaseEvent2
Show fields (31)
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_subtitlestring
  Subtitle shown in the public event listing.
- billing_payment_profileBillingPaymentProfile17
  Payment profile used for billing the event.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- scoreboard_sportstring
  Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.
- scoreboard_home_namestring
  Name of the home team on the scoreboard.
- scoreboard_away_namestring
  Name of the away team on the scoreboard.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- highlightboolean
  This property is used to mark an entity as highlighted
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.
- utagsarray<UnifiedTag4>
  Unified tags of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.

Responses

200Update a BaseEventBaseEvent3

Show fields (36)

ticketSeatingPlanIdinteger
Id of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
secondaryBaseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
baseLocationBaseLocation8
Show fields (31)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the event. Internal ID.
tokenstring
Public token of the event. Used in links and QR codes instead of the ID.
moments_modestring
Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
moments_designstring
Visual theme of the moments (digital guestbook) pages and exports.
public_keywordsstring
Keywords shown in the public event listing.
public_subtitlestring
Subtitle shown in the public event listing.
event_typestring
Type of the event, for example course, trip or tournament.
age_groupstring
Age group the event is intended for, for example children or adults.
min_ageinteger
Minimum age in years of participants.
max_ageinteger
Maximum age in years of participants.
min_age_monthsinteger
Minimum age in months of participants, for events for infants.
max_age_monthsinteger
Maximum age in months of participants, for events for infants.
min_grade_levelinteger
Minimum school grade level of participants.
max_grade_levelinteger
Maximum school grade level of participants.
age_toleranceinteger
Years by which participants may be outside the age range and still sign up.
event_people_limitinteger
maximum number of people that can attend the event
event_people_min_limitinteger
minimum number of people that must attend the event
hide_event_people_limitboolean
a setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitinteger
Maximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitinteger
Maximum number of participants who are neither recovered nor vaccinated.
has_wait_listboolean
The event has a waiting list once it is full.
wait_list_confirmation_requiredboolean
Participants from the waiting list must confirm their place.
trial_enabledboolean
Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
can_sign_up_for_main_eventboolean
Participants may sign up for the main event.
only_sign_up_for_main_eventboolean
Participants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeinteger
Number of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeinteger
Number of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeinteger
Hours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson49
CRM person who leads the event, for example the trainer.
Show fields (31)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- … 54 more fields
… 78 more fields

Request

curl --request PATCH \
  --url https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with package:http (no controller in the iw_erp_api package)

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

final response = await http.patch(
  Uri.parse('https://your-instance.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);

Response 200 application/json

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

This method will get all BaseEvent Objects for customer

GET/api/event/base_event_customer

Query parameters

`name`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`token`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseLocation`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`baseBookable`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`secondaryBaseBookable`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`eventType`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`ageGroup`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`processedMinAge`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`processedMaxAge`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`generateDayOfWeek`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`bitmaskDaysOfWeek`string	This is a bitmask value of the days of the week the event occurs on \| Requires access right: PUBLIC, LOGGED_IN, SCOPE
`bitmaskHoursStart`string	This is a bitmask value of the hours an event starts on \| Requires access right: PUBLIC, LOGGED_IN, SCOPE
`orderStringOne`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`orderStringTwo`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`orderWeekday`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`orderWeekdayOngoing`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`startTime`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`endTime`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`slugIdentifier`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`created`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`updated`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`minGradeLevel`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`maxGradeLevel`string	Requires access right: PUBLIC, LOGGED_IN, SCOPE
`highlight`boolean	This property is used to mark an entity as highlighted \| Requires access right: PUBLIC, LOGGED_IN, SCOPE
`trialEnabled`boolean	Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule. \| Requires access right: PUBLIC, LOGGED_IN, SCOPE
`deleted`boolean	This property is used to mark an entity as deleted / archived
`requireAge`boolean
`requireGradeLevel`boolean
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of BaseEvent objects for customerarray<BaseEvent3>

Show fields (36)

ticketSeatingPlanIdinteger
Id of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
secondaryBaseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
baseLocationBaseLocation8
Show fields (31)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the event. Internal ID.
tokenstring
Public token of the event. Used in links and QR codes instead of the ID.
moments_modestring
Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
moments_designstring
Visual theme of the moments (digital guestbook) pages and exports.
public_keywordsstring
Keywords shown in the public event listing.
public_subtitlestring
Subtitle shown in the public event listing.
event_typestring
Type of the event, for example course, trip or tournament.
age_groupstring
Age group the event is intended for, for example children or adults.
min_ageinteger
Minimum age in years of participants.
max_ageinteger
Maximum age in years of participants.
min_age_monthsinteger
Minimum age in months of participants, for events for infants.
max_age_monthsinteger
Maximum age in months of participants, for events for infants.
min_grade_levelinteger
Minimum school grade level of participants.
max_grade_levelinteger
Maximum school grade level of participants.
age_toleranceinteger
Years by which participants may be outside the age range and still sign up.
event_people_limitinteger
maximum number of people that can attend the event
event_people_min_limitinteger
minimum number of people that must attend the event
hide_event_people_limitboolean
a setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitinteger
Maximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitinteger
Maximum number of participants who are neither recovered nor vaccinated.
has_wait_listboolean
The event has a waiting list once it is full.
wait_list_confirmation_requiredboolean
Participants from the waiting list must confirm their place.
trial_enabledboolean
Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
can_sign_up_for_main_eventboolean
Participants may sign up for the main event.
only_sign_up_for_main_eventboolean
Participants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeinteger
Number of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeinteger
Number of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeinteger
Hours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson49
CRM person who leads the event, for example the trainer.
Show fields (31)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- … 54 more fields
… 78 more fields

Request

curl --request GET \
  --url https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with the iw_erp_api package

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

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

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

Response 200 application/json

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

This method will get bookings for a BaseEvent with the given id or token

GET/api/event/base_event_base_booking/{identifier}

Path parameters

identifierrequiredstring

Query parameters

`deleted`boolean	This property is used to mark an entity as deleted / archived \| Requires access right: PUBLIC_LIST
`baseLocation`string	Requires access right: PUBLIC_LIST
`baseEvent`string	Requires access right: PUBLIC_LIST
`baseBookable`string	Requires access right: PUBLIC_LIST
`secondaryBaseBookable`string	Requires access right: PUBLIC_LIST
`baseBookable---secondaryBaseBookable`string	Requires access right: PUBLIC_LIST
`user`string	Requires access right: PUBLIC_LIST
`startTime`string	Requires access right: PUBLIC_LIST
`endTime`string	Requires access right: PUBLIC_LIST
`color`string	Requires access right: PUBLIC_LIST
`billed`boolean	Requires access right: PUBLIC_LIST
`waiting`boolean	Requires access right: PUBLIC_LIST
`bookingType`string	Requires access right: PUBLIC_LIST
`contentType`string	Requires access right: PUBLIC_LIST
`bookingStatus`string	Requires access right: PUBLIC_LIST
`addonData_publicDeleted`string	Requires access right: PUBLIC_LIST
`addonData_addressAutoCompleteType`string	Requires access right: PUBLIC_LIST
`eventType`string	denormalized event type from BaseEvent for fast filtering \| Requires access right: PUBLIC_LIST
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of BaseBooking objects for the given eventarray<BaseBooking2>

Show fields (5)

baseLocationBaseLocation10
Show fields (29)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10
Show fields (50)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation10
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
secondaryBaseBookableBaseBookable10
Show fields (50)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation10
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
baseEventBaseEvent13
Show fields (68)
- ticketSeatingPlanIdinteger
  Id of the seating plan, also for the public and the customer serialization.
- bib_numbers_enabledboolean
- timing_enabledboolean
- baseBookableBaseBookable10
- secondaryBaseBookableBaseBookable10
- baseLocationBaseLocation10
- idinteger
  Primary key of the event. Internal ID.
- tokenstring
  Public token of the event. Used in links and QR codes instead of the ID.
- moments_modestring
  Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
- moments_designstring
  Visual theme of the moments (digital guestbook) pages and exports.
- public_keywordsstring
  Keywords shown in the public event listing.
- public_subtitlestring
  Subtitle shown in the public event listing.
- event_typestring
  Type of the event, for example course, trip or tournament.
- age_groupstring
  Age group the event is intended for, for example children or adults.
- min_ageinteger
  Minimum age in years of participants.
- max_ageinteger
  Maximum age in years of participants.
- min_age_monthsinteger
  Minimum age in months of participants, for events for infants.
- max_age_monthsinteger
  Maximum age in months of participants, for events for infants.
- min_grade_levelinteger
  Minimum school grade level of participants.
- max_grade_levelinteger
  Maximum school grade level of participants.
- age_toleranceinteger
  Years by which participants may be outside the age range and still sign up.
- event_people_limitinteger
  maximum number of people that can attend the event
- event_people_min_limitinteger
  minimum number of people that must attend the event
- hide_event_people_limitboolean
  a setting to hide the event people limit in the frontend ui
- event_people_recovered_vaccinated_limitinteger
  Maximum number of recovered or vaccinated participants.
- event_people_not_recovered_vaccinated_limitinteger
  Maximum number of participants who are neither recovered nor vaccinated.
- has_wait_listboolean
  The event has a waiting list once it is full.
- wait_list_confirmation_requiredboolean
  Participants from the waiting list must confirm their place.
- trial_enabledboolean
  Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
- can_sign_up_for_main_eventboolean
  Participants may sign up for the main event.
- only_sign_up_for_main_eventboolean
  Participants may only sign up for the main event, not for sub-events.
- sign_up_limit_days_beforeinteger
  Number of days before the start until which sign-ups are possible.
- sign_up_limit_stop_days_beforeinteger
  Number of days before the start from which sign-ups are closed.
- sign_up_delete_hours_beforeinteger
  Hours before the start until which a participant can cancel the sign-up.
- performing_personCRMPerson10
  CRM person who leads the event, for example the trainer.
- secondary_performing_personCRMPerson10
  Second CRM person who leads the event.
- start_timestring (date-time)
  Start of the event.
- end_timestring (date-time)
  End of the event.
- require_addressboolean
  Participants must enter an address when signing up.
- require_contactboolean
  Participants must enter contact details when signing up.
- require_billingboolean
  Participants must enter billing details when signing up.
- allow_direct_billingboolean
- require_direct_billingboolean
- allow_budget_sign_upboolean
- require_ageboolean
  Participants must enter their age when signing up.
- require_grade_levelboolean
  Participants must enter their school grade level when signing up.
- require_free_note_field_idsstring
  IDs of the free note fields that participants must fill in.
- generate_new_bookingsboolean
  Bookings are generated automatically for the event schedule.
- generate_new_bookings_v2boolean
  Bookings are generated with the second version of the schedule generator.
- generate_ignore_sys_calendarboolean
  Generated bookings ignore the holidays of the system calendar.
- copy_main_sign_ups_to_bookingboolean
  Sign-ups of the main event are copied to the generated bookings.
- generate_hour_startstring (date-time)
  Start time of the day for generated bookings.
- generate_hour_endstring (date-time)
  End time of the day for generated bookings.
- generate_day_of_weekinteger
  Weekday for generated bookings.
- bitmask_days_of_weekinteger
  This is a bitmask value of the days of the week the event occurs on
- bitmask_hours_startinteger
  This is a bitmask value of the hours an event starts on
- summarized_date_timesstring
  This is a string with the days and hours an event starts on
- customer_detail_ctastring
  Call-to-action text shown in the customer app on the event detail page.
- customer_badgestring
  Badge text shown on the event in the customer app.
- bib_number_modestring
  Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).
- timing_gun_startstring (date-time)
  Startschuss; ohne Wert gilt startTime.
- timing_rank_bystring
  Wertung nach Netto- (NET) oder Bruttozeit (GROSS).
- timing_min_lap_secondsinteger
  Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
- timing_public_liveboolean
  Live timing results are public.
- timing_gps_trackingboolean
  GPS tracking of participants is enabled for timing.
- timing_self_check_inboolean
  Participants can check in themselves for timing.
- scoreboard_enabledboolean
  Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
… 42 more fields

Request

curl --request GET \
  --url https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with the iw_erp_api package

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

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

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

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

Returns a single highlighted BaseEvent. If multiple highlighted events match the query, one is selected randomly. Result is cached for 10 minutes.

GET/api/event/base_event_highlight

Query parameters

`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a single highlighted BaseEventBaseEvent3

Show fields (36)

ticketSeatingPlanIdinteger
Id of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledboolean
timing_enabledboolean
baseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
secondaryBaseBookableBaseBookable9
Show fields (52)
- ticketSeatingPlanIdinteger
  Id of the seating plan of the room, also for the public serialization.
- baseLocationBaseLocation8
- idinteger
  Primary key of the bookable. Internal ID.
- tokenstring
  Public token of the bookable. Used in links instead of the ID.
- bookable_typestring
  Type of the bookable, for example room, court or vehicle.
- floor_levelstring
  Floor the bookable is on.
- floor_sizeinteger
  Floor size in square meters.
- pets_allowedboolean
  Pets are allowed.
- barrier_freeboolean
  The bookable is barrier-free.
- cargo_volumeinteger
  Cargo volume in liters.
- fuel_typestring
  Fuel type of the vehicle.
- seating_capacityinteger
  Number of seats.
- has_wait_listboolean
  The bookable has a waiting list once it is fully booked.
- booking_limitinteger
  Maximum number of bookings.
- billing_modestring
  How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
- max_active_bookings_per_userinteger
  Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
- max_advance_booking_hoursinteger
  Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
- inventory_managedboolean
  Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
- inventory_depositnumber (float)
  Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
- require_addressboolean
  The address must be entered when booking.
- require_contactboolean
  Contact details must be entered when booking.
- require_billingboolean
  Billing details must be entered when booking.
- require_booking_titleboolean
  A title must be entered when booking.
- allow_direct_billingboolean
- require_ageboolean
  The age must be entered when booking.
- counter_update_modestring
  How the usage counters of the bookable are updated.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
baseLocationBaseLocation8
Show fields (31)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the event. Internal ID.
tokenstring
Public token of the event. Used in links and QR codes instead of the ID.
moments_modestring
Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token
moments_designstring
Visual theme of the moments (digital guestbook) pages and exports.
public_keywordsstring
Keywords shown in the public event listing.
public_subtitlestring
Subtitle shown in the public event listing.
event_typestring
Type of the event, for example course, trip or tournament.
age_groupstring
Age group the event is intended for, for example children or adults.
min_ageinteger
Minimum age in years of participants.
max_ageinteger
Maximum age in years of participants.
min_age_monthsinteger
Minimum age in months of participants, for events for infants.
max_age_monthsinteger
Maximum age in months of participants, for events for infants.
min_grade_levelinteger
Minimum school grade level of participants.
max_grade_levelinteger
Maximum school grade level of participants.
age_toleranceinteger
Years by which participants may be outside the age range and still sign up.
event_people_limitinteger
maximum number of people that can attend the event
event_people_min_limitinteger
minimum number of people that must attend the event
hide_event_people_limitboolean
a setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitinteger
Maximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitinteger
Maximum number of participants who are neither recovered nor vaccinated.
has_wait_listboolean
The event has a waiting list once it is full.
wait_list_confirmation_requiredboolean
Participants from the waiting list must confirm their place.
trial_enabledboolean
Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.
can_sign_up_for_main_eventboolean
Participants may sign up for the main event.
only_sign_up_for_main_eventboolean
Participants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeinteger
Number of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeinteger
Number of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeinteger
Hours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson49
CRM person who leads the event, for example the trainer.
Show fields (31)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- … 54 more fields
… 78 more fields

Request

curl --request GET \
  --url https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with the iw_erp_api package

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

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

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

Response 200 application/json

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