Booking
Returns a list of BaseBooking
GET/api/event/base_booking
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Returns a list of BaseBookingarray<BaseBooking3>
Show fields (18)
companyCRMCompanyShow fields (55)
idintegerPrimary key of the company. Internal ID.
short_namestringShort name of the company.
company_namestringLegal name of the company.
secondary_namestringSecond name line of the company.
direct_dialstringDirect dial number of the company.
invoice_emailstringE-mail address for invoices.
send_invoice_emailbooleanSend invoices by e-mail.
send_invoice_letterbooleanSend invoices by letter.
time_report_emailstringE-mail address for time reports.
payment_goalPaymentGoalPayment term of the company.
payment_intervalstringInterval of the payments.
vatidstringVAT identification number.
taxnumberstringTax number of the company.
buyer_reference_idstringLeitweg-ID or custom reference ID defined by the customer
taxTaxTax rate used for the company.
infostringInformation about the company.
numberstringCustomer or supplier number of the company.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringCompany number as text, including prefix.
is_customerbooleanThe company is a customer.
is_supplierbooleanThe company is a supplier.
is_otherbooleanThe company is neither customer nor supplier.
is_memberbooleanThe company is a member.
archivedbooleanThe company is archived.
categoryCRMCompanyCategoryCategory of the company.
visible_for_customerbooleanWhether the company is visible to the customer.
founding_datestring (date-time)Founding date of the company.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
payment_typePaymentTypecompany_employee_countintegerNumber of employees of the company.
company_founding_yearintegerFounding year of the company.
company_family_ownedbooleanWhether the company is family-owned.
company_sales_volumestringSales volume of the company.
company_segmentstringMarket segment of the company.
userUser14Show fields (10)
idintegerPrimary key of the user. Internal ID of the login user.
namestringDisplay name of the user. Shown in the UI and in audit entries.
usernamestringLogin name of the user. Must be unique across all users.
emailstringE-mail address of the user. Used for login notifications, password resets and as a login alias.
positioningeneralstringFree text describing the position or role of the user.
crm_personCRMPerson10CRM person linked to this login user. Connects the login account with the person record.
profile_picture_urlstringURL of the profile picture of the user.
archivedbooleanMarks the user as archived. Archived users are kept for history and are not active.
require2fabooleanTwo-factor authentication is required for this user.
search_stringstringText that the entity can be searched by.
idintegerPrimary key of the booking. Internal ID.
start_timestring (date-time)Start of the booking.
end_timestring (date-time)End of the booking.
booking_typestringType of the booking, for example normal or substitution.
booking_statusstringStatus of the booking, for example planned, done or cancelled.
auto_invoicebooleanInvoices for this booking are created automatically.
waitingbooleanThe booking is on the waiting list.
confirmedbooleanThe booking is confirmed.
externalbooleanThe booking was made by an external party.
deletion_reasonstringReason the booking was cancelled.
deletion_datestring (date-time)When the booking was cancelled, set by setDeleted() - null while active and for bookings cancelled before this field existed
billedbooleanThe booking was billed.
invoiceInvoice23Invoice the booking was billed on.
Show fields (38)
idintegerPrimary key of the invoice document. Internal ID.
tokenstringToken that identifies the document for public access.
numberintegerRunning document number.
manual_number_prefixstringPrefix of a manually entered document number.
manual_numberintegerManually entered document number.
number_stringstringDocument number as displayed to users.
generation_datestring (date-time)Date the document was generated.
number_datestring (date-time)Date used for the document number.
messagestringMessage printed on the document.
currencystringCurrency of the document.
namestringName of the document.
due_datestring (date-time)Due date of the document.
netto_valuenumber (float)Net total of the document.
brutto_valuenumber (float)Gross total of the document.
tax_valuenumber (float)Total tax amount of the document.
taxTaxrequiredTax rate applied to the document.
linked_number_titlestringTitle of the linked document number.
linked_numberstringNumber of the linked document.
statusstringStatus of the document.
previous_statusstringStatus before the last change.
status_updatedstring (date-time)Point in time the status was last changed.
archivedbooleanWhether the document is archived.
last_pdf_exportstring (date-time)Point in time the PDF was last exported.
last_status_exportstringStatus at the last export.
search_stringstringText that the entity can be searched by.
accounting_typeAccountingTyperequiredAccounting type of the invoice.
payment_typePaymentTypePayment type of the invoice.
payment_goalPaymentGoalPayment term of the invoice.
expense_categoryExpenseCategory10EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
buyerInvoiceBuyer22Buyer of the invoice.
payment_datestring (date-time)Date the invoice was paid.
vat_categorystringDer umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_servicebooleanThe payment date comes from an external service.
direct_debit_exportedbooleanThe invoice was exported for direct debit.
cancel_datestring (date-time)Date the invoice was canceled.
cancel_textstringText of the cancellation.
start_datestring (date-time)Start of the billed period.
end_datestring (date-time)End of the billed period.
performing_personCRMPerson10CRM person who leads the booking.
Show fields (81)
idintegerPrimary key of the person. Internal ID.
first_namestringFirst name of the person.
last_namestringLast name of the person.
numberintegerMember or customer number of the person.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringMember or customer number as text, including prefix.
genderstringGender of the person.
titlestringAcademic or other title of the person.
positionstringPosition or role of the person.
languagestringPreferred language of the person.
special_salutationstringSpecial salutation text for letters.
form_of_salutationstringForm of salutation, for example formal or informal.
birthdaystring (date-time)Birthday of the person.
known_allergiesstringKnown allergies of the person.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanPhotos of the person may be taken and published.
allow_leaving_alonebooleanThe person may leave the event alone.
authorized_pickupstringPersons who are allowed to pick up the person.
needs_supportbooleanThe person needs support, for example for inclusion.
support_descriptionstringDescription of the support the person needs.
financial_supportbooleanThe person receives financial support.
financial_support_numberstringNumber of the financial support.
municipal_supportbooleanThe person receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the person.
school_classstringSchool class of the person.
start_timestring (date-time)Start of the membership or activity.
start_time_reasonstringReason for the start.
end_timestring (date-time)End of the membership or activity.
end_time_reasonstringReason for the end.
confirmed_gtc_timestring (date-time)Time the general terms and conditions were confirmed.
chatbot_opt_inbooleanEinwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
chatbot_opt_in_atstring (date-time)Time the person opted in to the chatbot.
chatbot_opt_in_text_versionstringVersion des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
app_usage_statistics_opt_outbooleanWiderspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
crm_person_contact_dataarray<CRMPersonContactData>Contact data of the person, for example phone and e-mail.
archivedbooleanWhether the person is archived.
subscribed_newsletterbooleanWhether the person subscribed to the newsletter.
subscribed_magazinebooleanWhether the person subscribed to the magazine.
printed_member_cardbooleanWhether a member card has been printed for the person.
has_login_userbooleanWhether the person has a login user.
profile_picture_urlstringURL of the profile picture of the person.
log_book_staffbooleanLog book flag: staff.
log_book_staff1booleanLog book flag: staff, level 1.
log_book_staff2booleanLog book flag: staff, level 2.
log_book_memberbooleanLog book flag: member.
log_book_trainerbooleanLog book flag: trainer.
log_book_trainer1booleanLog book flag: trainer, level 1.
log_book_trainer2booleanLog book flag: trainer, level 2.
log_book_head_of_departmentbooleanLog book flag: head of department.
log_book_supervisory_boardbooleanLog book flag: supervisory board.
log_book_board_of_directorsbooleanLog book flag: board of directors.
log_book_honorary_memberbooleanLog book flag: honorary member.
log_book_club_card_onebooleanLog book flag: club card.
log_book_health_recoveredbooleanLog book flag: recovered from illness.
log_book_health_vaccinatedbooleanLog book flag: vaccinated.
log_book_health_vaccinated_additionstringDetails of the vaccination.
log_book_good_conductbooleanLog book flag: certificate of good conduct.
log_book_first_aidbooleanLog book flag: first aid training.
log_book_measles_vaccinationbooleanLog book flag: measles vaccination.
sync_lanistabooleanWhether the person is synchronized with Lanista.
categoryCRMPersonCategoryPerson category.
nicknamestringNickname of the person.
preferred_color_hexstringPreferred color of the person as hex value.
avatar_tokenstringToken of the avatar image.
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)Point in time the entity was created.
- … 2 more fields
secondary_performing_personCRMPerson10Second CRM person who leads the booking.
Show fields (1)
- … 82 more fields
- … 36 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_booking \
--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_booking', 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_booking"
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_booking', [
'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_booking"),
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_booking")
.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_booking"
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_booking_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 EventBaseBookingController.getAll();
if (result.success) {
print(result.data);
}[
{
"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"
}
]Creates a single BaseBooking
POST/api/event/base_booking
Request body application/json
dataBaseBooking24Show fields (8)
deletedbooleanThis property is used to mark an entity as deleted / archived
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
Responses
200Creates a single BaseBookingBaseBooking5
Show fields (6)
companyCRMCompanyShow fields (55)
idintegerPrimary key of the company. Internal ID.
short_namestringShort name of the company.
company_namestringLegal name of the company.
secondary_namestringSecond name line of the company.
direct_dialstringDirect dial number of the company.
invoice_emailstringE-mail address for invoices.
send_invoice_emailbooleanSend invoices by e-mail.
send_invoice_letterbooleanSend invoices by letter.
time_report_emailstringE-mail address for time reports.
payment_goalPaymentGoalPayment term of the company.
payment_intervalstringInterval of the payments.
vatidstringVAT identification number.
taxnumberstringTax number of the company.
buyer_reference_idstringLeitweg-ID or custom reference ID defined by the customer
taxTaxTax rate used for the company.
infostringInformation about the company.
numberstringCustomer or supplier number of the company.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringCompany number as text, including prefix.
is_customerbooleanThe company is a customer.
is_supplierbooleanThe company is a supplier.
is_otherbooleanThe company is neither customer nor supplier.
is_memberbooleanThe company is a member.
archivedbooleanThe company is archived.
categoryCRMCompanyCategoryCategory of the company.
visible_for_customerbooleanWhether the company is visible to the customer.
founding_datestring (date-time)Founding date of the company.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
payment_typePaymentTypecompany_employee_countintegerNumber of employees of the company.
company_founding_yearintegerFounding year of the company.
company_family_ownedbooleanWhether the company is family-owned.
company_sales_volumestringSales volume of the company.
company_segmentstringMarket segment of the company.
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent18Show fields (12)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
- … 91 more fields
- … 52 more fields
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_booking \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
payment_bic: 'BYLADEM1001',
payment_iban: 'DE02120300000000202051',
deleted: true,
payment_owner: 'string',
payment_institution: 'string',
payment_mandate: '2026-10-15T09:30:00+02:00'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/base_booking', 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_booking"
payload = { "data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": True,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
} }
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_booking', [
'body' => '{"data":{"payment_bic":"BYLADEM1001","payment_iban":"DE02120300000000202051","deleted":true,"payment_owner":"string","payment_institution":"string","payment_mandate":"2026-10-15T09:30:00+02:00"}}',
'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_booking"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
{
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\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_booking")
.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_booking"
payload := strings.NewReader("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
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_booking_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_booking.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingController.post(EventBaseBooking.fromJson({
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}));
if (result.success) {
print(result.data);
}{
"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 BaseBooking
GET/api/event/base_booking/{identifier}
Path parameters
identifierrequiredstring |
Responses
200Returns a single BaseBookingBaseBooking5
Show fields (6)
companyCRMCompanyShow fields (55)
idintegerPrimary key of the company. Internal ID.
short_namestringShort name of the company.
company_namestringLegal name of the company.
secondary_namestringSecond name line of the company.
direct_dialstringDirect dial number of the company.
invoice_emailstringE-mail address for invoices.
send_invoice_emailbooleanSend invoices by e-mail.
send_invoice_letterbooleanSend invoices by letter.
time_report_emailstringE-mail address for time reports.
payment_goalPaymentGoalPayment term of the company.
payment_intervalstringInterval of the payments.
vatidstringVAT identification number.
taxnumberstringTax number of the company.
buyer_reference_idstringLeitweg-ID or custom reference ID defined by the customer
taxTaxTax rate used for the company.
infostringInformation about the company.
numberstringCustomer or supplier number of the company.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringCompany number as text, including prefix.
is_customerbooleanThe company is a customer.
is_supplierbooleanThe company is a supplier.
is_otherbooleanThe company is neither customer nor supplier.
is_memberbooleanThe company is a member.
archivedbooleanThe company is archived.
categoryCRMCompanyCategoryCategory of the company.
visible_for_customerbooleanWhether the company is visible to the customer.
founding_datestring (date-time)Founding date of the company.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
payment_typePaymentTypecompany_employee_countintegerNumber of employees of the company.
company_founding_yearintegerFounding year of the company.
company_family_ownedbooleanWhether the company is family-owned.
company_sales_volumestringSales volume of the company.
company_segmentstringMarket segment of the company.
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent18Show fields (12)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
- … 91 more fields
- … 52 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/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_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_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_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_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_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_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_booking_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 EventBaseBookingController.get('42');
if (result.success) {
print(result.data);
}{
"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"
}Updates a single BaseBooking
PUT/api/event/base_booking/{identifier}
Path parameters
identifierrequiredstring |
Query parameters
suppressNotificationboolean | If true and this update cancels the booking (deleted=true), no automatic cancellation notification is sent for this action. |
Request body application/json
dataBaseBooking24Show fields (8)
deletedbooleanThis property is used to mark an entity as deleted / archived
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
Responses
200Updates a single BaseBookingBaseBooking5
Show fields (6)
companyCRMCompanyShow fields (55)
idintegerPrimary key of the company. Internal ID.
short_namestringShort name of the company.
company_namestringLegal name of the company.
secondary_namestringSecond name line of the company.
direct_dialstringDirect dial number of the company.
invoice_emailstringE-mail address for invoices.
send_invoice_emailbooleanSend invoices by e-mail.
send_invoice_letterbooleanSend invoices by letter.
time_report_emailstringE-mail address for time reports.
payment_goalPaymentGoalPayment term of the company.
payment_intervalstringInterval of the payments.
vatidstringVAT identification number.
taxnumberstringTax number of the company.
buyer_reference_idstringLeitweg-ID or custom reference ID defined by the customer
taxTaxTax rate used for the company.
infostringInformation about the company.
numberstringCustomer or supplier number of the company.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringCompany number as text, including prefix.
is_customerbooleanThe company is a customer.
is_supplierbooleanThe company is a supplier.
is_otherbooleanThe company is neither customer nor supplier.
is_memberbooleanThe company is a member.
archivedbooleanThe company is archived.
categoryCRMCompanyCategoryCategory of the company.
visible_for_customerbooleanWhether the company is visible to the customer.
founding_datestring (date-time)Founding date of the company.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
payment_typePaymentTypecompany_employee_countintegerNumber of employees of the company.
company_founding_yearintegerFounding year of the company.
company_family_ownedbooleanWhether the company is family-owned.
company_sales_volumestringSales volume of the company.
company_segmentstringMarket segment of the company.
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent18Show fields (12)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
- … 91 more fields
- … 52 more fields
curl --request PUT \
--url https://your-instance.iw-erp.de/api/event/base_booking/42 \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}
}
'const options = {
method: 'PUT',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
payment_bic: 'BYLADEM1001',
payment_iban: 'DE02120300000000202051',
deleted: true,
payment_owner: 'string',
payment_institution: 'string',
payment_mandate: '2026-10-15T09:30:00+02:00'
}
})
};
fetch('https://your-instance.iw-erp.de/api/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_booking/42"
payload = { "data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": True,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
} }
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_booking/42', [
'body' => '{"data":{"payment_bic":"BYLADEM1001","payment_iban":"DE02120300000000202051","deleted":true,"payment_owner":"string","payment_institution":"string","payment_mandate":"2026-10-15T09:30:00+02:00"}}',
'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_booking/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
{
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\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_booking/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_booking/42"
payload := strings.NewReader("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
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_booking_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_booking.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingController.put(EventBaseBooking.fromJson({
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}));
if (result.success) {
print(result.data);
}{
"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"
}Updates a single BaseBooking
PATCH/api/event/base_booking/{identifier}
Path parameters
identifierrequiredstring |
Query parameters
suppressNotificationboolean | If true and this update cancels the booking (deleted=true), no automatic cancellation notification is sent for this action. |
Request body application/json
dataBaseBooking24Show fields (8)
deletedbooleanThis property is used to mark an entity as deleted / archived
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
Responses
200Updates a single BaseBookingBaseBooking5
Show fields (6)
companyCRMCompanyShow fields (55)
idintegerPrimary key of the company. Internal ID.
short_namestringShort name of the company.
company_namestringLegal name of the company.
secondary_namestringSecond name line of the company.
direct_dialstringDirect dial number of the company.
invoice_emailstringE-mail address for invoices.
send_invoice_emailbooleanSend invoices by e-mail.
send_invoice_letterbooleanSend invoices by letter.
time_report_emailstringE-mail address for time reports.
payment_goalPaymentGoalPayment term of the company.
payment_intervalstringInterval of the payments.
vatidstringVAT identification number.
taxnumberstringTax number of the company.
buyer_reference_idstringLeitweg-ID or custom reference ID defined by the customer
taxTaxTax rate used for the company.
infostringInformation about the company.
numberstringCustomer or supplier number of the company.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringCompany number as text, including prefix.
is_customerbooleanThe company is a customer.
is_supplierbooleanThe company is a supplier.
is_otherbooleanThe company is neither customer nor supplier.
is_memberbooleanThe company is a member.
archivedbooleanThe company is archived.
categoryCRMCompanyCategoryCategory of the company.
visible_for_customerbooleanWhether the company is visible to the customer.
founding_datestring (date-time)Founding date of the company.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
payment_typePaymentTypecompany_employee_countintegerNumber of employees of the company.
company_founding_yearintegerFounding year of the company.
company_family_ownedbooleanWhether the company is family-owned.
company_sales_volumestringSales volume of the company.
company_segmentstringMarket segment of the company.
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent18Show fields (12)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
- … 91 more fields
- … 52 more fields
curl --request PATCH \
--url https://your-instance.iw-erp.de/api/event/base_booking/42 \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}
}
'const options = {
method: 'PATCH',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
payment_bic: 'BYLADEM1001',
payment_iban: 'DE02120300000000202051',
deleted: true,
payment_owner: 'string',
payment_institution: 'string',
payment_mandate: '2026-10-15T09:30:00+02:00'
}
})
};
fetch('https://your-instance.iw-erp.de/api/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_booking/42"
payload = { "data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": True,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
} }
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_booking/42', [
'body' => '{"data":{"payment_bic":"BYLADEM1001","payment_iban":"DE02120300000000202051","deleted":true,"payment_owner":"string","payment_institution":"string","payment_mandate":"2026-10-15T09:30:00+02:00"}}',
'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_booking/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
{
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\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/base_booking/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_booking/42"
payload := strings.NewReader("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
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_booking/42'),
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: jsonEncode({
"data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}
}),
);
print(response.body);{
"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"
}Deletes a single BaseBooking
DELETE/api/event/base_booking/{identifier}
Path parameters
identifierrequiredstring |
Responses
200Deletes a single BaseBookingBaseBooking5
Show fields (6)
companyCRMCompanyShow fields (55)
idintegerPrimary key of the company. Internal ID.
short_namestringShort name of the company.
company_namestringLegal name of the company.
secondary_namestringSecond name line of the company.
direct_dialstringDirect dial number of the company.
invoice_emailstringE-mail address for invoices.
send_invoice_emailbooleanSend invoices by e-mail.
send_invoice_letterbooleanSend invoices by letter.
time_report_emailstringE-mail address for time reports.
payment_goalPaymentGoalPayment term of the company.
payment_intervalstringInterval of the payments.
vatidstringVAT identification number.
taxnumberstringTax number of the company.
buyer_reference_idstringLeitweg-ID or custom reference ID defined by the customer
taxTaxTax rate used for the company.
infostringInformation about the company.
numberstringCustomer or supplier number of the company.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringCompany number as text, including prefix.
is_customerbooleanThe company is a customer.
is_supplierbooleanThe company is a supplier.
is_otherbooleanThe company is neither customer nor supplier.
is_memberbooleanThe company is a member.
archivedbooleanThe company is archived.
categoryCRMCompanyCategoryCategory of the company.
visible_for_customerbooleanWhether the company is visible to the customer.
founding_datestring (date-time)Founding date of the company.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
payment_typePaymentTypecompany_employee_countintegerNumber of employees of the company.
company_founding_yearintegerFounding year of the company.
company_family_ownedbooleanWhether the company is family-owned.
company_sales_volumestringSales volume of the company.
company_segmentstringMarket segment of the company.
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent18Show fields (12)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
- … 91 more fields
- … 52 more fields
curl --request DELETE \
--url https://your-instance.iw-erp.de/api/event/base_booking/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/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_booking/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.delete(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/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.Delete,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/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_booking/42")
.delete(null)
.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_booking/42"
req, _ := http.NewRequest("DELETE", 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_booking_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 EventBaseBookingController.delete('42');
if (result.success) {
print(result.data);
}{
"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"
}Test a new BaseBooking
POST/api/event/base_booking_test
Responses
200Test a new BaseBookingBaseBooking2
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent13Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson10CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson10Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 42 more fields
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_booking_test \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_booking_test', 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_booking_test"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, 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_booking_test', [
'headers' => [
'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_booking_test"),
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_booking_test")
.post(null)
.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_booking_test"
req, _ := http.NewRequest("POST", 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_booking_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_booking.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingController.test(EventBaseBooking.fromJson({}));
if (result.success) {
print(result.data);
}{
"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"
}Adds an uploaded Attachment to a BaseBooking (upload first via /api/attachments/{companyId}/companies)
POST/api/event/base_booking/{identifier}/adds/attachments
Path parameters
identifierrequiredstring |
Responses
200Adds an Attachment to a BaseBookingBaseBooking6
Show fields (6)
companyCRMCompanyShow fields (55)
idintegerPrimary key of the company. Internal ID.
short_namestringShort name of the company.
company_namestringLegal name of the company.
secondary_namestringSecond name line of the company.
direct_dialstringDirect dial number of the company.
invoice_emailstringE-mail address for invoices.
send_invoice_emailbooleanSend invoices by e-mail.
send_invoice_letterbooleanSend invoices by letter.
time_report_emailstringE-mail address for time reports.
payment_goalPaymentGoalPayment term of the company.
payment_intervalstringInterval of the payments.
vatidstringVAT identification number.
taxnumberstringTax number of the company.
buyer_reference_idstringLeitweg-ID or custom reference ID defined by the customer
taxTaxTax rate used for the company.
infostringInformation about the company.
numberstringCustomer or supplier number of the company.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringCompany number as text, including prefix.
is_customerbooleanThe company is a customer.
is_supplierbooleanThe company is a supplier.
is_otherbooleanThe company is neither customer nor supplier.
is_memberbooleanThe company is a member.
archivedbooleanThe company is archived.
categoryCRMCompanyCategoryCategory of the company.
visible_for_customerbooleanWhether the company is visible to the customer.
founding_datestring (date-time)Founding date of the company.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
payment_typePaymentTypecompany_employee_countintegerNumber of employees of the company.
company_founding_yearintegerFounding year of the company.
company_family_ownedbooleanWhether the company is family-owned.
company_sales_volumestringSales volume of the company.
company_segmentstringMarket segment of the company.
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent18Show fields (12)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
- … 91 more fields
- … 53 more fields
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_booking/42/adds/attachments \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_booking/42/adds/attachments', 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_booking/42/adds/attachments"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, 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_booking/42/adds/attachments', [
'headers' => [
'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_booking/42/adds/attachments"),
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_booking/42/adds/attachments")
.post(null)
.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_booking/42/adds/attachments"
req, _ := http.NewRequest("POST", 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_booking_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/attachment.dart';
import 'package:iw_erp_api/model/event_base_booking.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingController.addAttachment(EventBaseBooking.fromJson({}), Attachment.fromJson({}));
if (result.success) {
print(result.data);
}{
"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"
}Removes an Attachment from a BaseBooking (the file itself stays in the attachment list)
POST/api/event/base_booking/{identifier}/removes/attachments
Path parameters
identifierrequiredstring |
Responses
200Removes an Attachment from a BaseBookingBaseBooking6
Show fields (6)
companyCRMCompanyShow fields (55)
idintegerPrimary key of the company. Internal ID.
short_namestringShort name of the company.
company_namestringLegal name of the company.
secondary_namestringSecond name line of the company.
direct_dialstringDirect dial number of the company.
invoice_emailstringE-mail address for invoices.
send_invoice_emailbooleanSend invoices by e-mail.
send_invoice_letterbooleanSend invoices by letter.
time_report_emailstringE-mail address for time reports.
payment_goalPaymentGoalPayment term of the company.
payment_intervalstringInterval of the payments.
vatidstringVAT identification number.
taxnumberstringTax number of the company.
buyer_reference_idstringLeitweg-ID or custom reference ID defined by the customer
taxTaxTax rate used for the company.
infostringInformation about the company.
numberstringCustomer or supplier number of the company.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringCompany number as text, including prefix.
is_customerbooleanThe company is a customer.
is_supplierbooleanThe company is a supplier.
is_otherbooleanThe company is neither customer nor supplier.
is_memberbooleanThe company is a member.
archivedbooleanThe company is archived.
categoryCRMCompanyCategoryCategory of the company.
visible_for_customerbooleanWhether the company is visible to the customer.
founding_datestring (date-time)Founding date of the company.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
payment_typePaymentTypecompany_employee_countintegerNumber of employees of the company.
company_founding_yearintegerFounding year of the company.
company_family_ownedbooleanWhether the company is family-owned.
company_sales_volumestringSales volume of the company.
company_segmentstringMarket segment of the company.
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent18Show fields (12)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
- … 91 more fields
- … 53 more fields
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_booking/42/removes/attachments \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_booking/42/removes/attachments', 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_booking/42/removes/attachments"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, 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_booking/42/removes/attachments', [
'headers' => [
'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_booking/42/removes/attachments"),
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_booking/42/removes/attachments")
.post(null)
.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_booking/42/removes/attachments"
req, _ := http.NewRequest("POST", 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_booking_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/attachment.dart';
import 'package:iw_erp_api/model/event_base_booking.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingController.removeAttachment(EventBaseBooking.fromJson({}), Attachment.fromJson({}));
if (result.success) {
print(result.data);
}{
"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"
}Updates an existing field in multiple bookings entry.
POST/api/event/base_booking_update_multi
Responses
default
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/base_booking_update_multi \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/base_booking_update_multi', 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_booking_update_multi"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, 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_booking_update_multi', [
'headers' => [
'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_booking_update_multi"),
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_booking_update_multi")
.post(null)
.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_booking_update_multi"
req, _ := http.NewRequest("POST", 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_booking_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/simple_change_list.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingController.updateMultiple(SimpleChangeList.fromJson({}));
if (result.success) {
print(result.data);
}Returns bookings that overlap the given period on the given bookables, ignoring bookings of type BLOCKING.
GET/api/event/base_booking_check_overlaps
Used to warn the user before saving a blocking booking that would conflict with existing appointments.
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Returns overlapping bookings for a potential blocking bookingarray<BaseBooking7>
Show fields (16)
idintegerPrimary key of the booking. Internal ID.
start_timestring (date-time)Start of the booking.
end_timestring (date-time)End of the booking.
booking_typestringType of the booking, for example normal or substitution.
booking_statusstringStatus of the booking, for example planned, done or cancelled.
auto_invoicebooleanInvoices for this booking are created automatically.
waitingbooleanThe booking is on the waiting list.
confirmedbooleanThe booking is confirmed.
externalbooleanThe booking was made by an external party.
deletion_reasonstringReason the booking was cancelled.
deletion_datestring (date-time)When the booking was cancelled, set by setDeleted() - null while active and for bookings cancelled before this field existed
billedbooleanThe booking was billed.
invoiceInvoice26Invoice the booking was billed on.
Show fields (38)
idintegerPrimary key of the invoice document. Internal ID.
tokenstringToken that identifies the document for public access.
numberintegerRunning document number.
manual_number_prefixstringPrefix of a manually entered document number.
manual_numberintegerManually entered document number.
number_stringstringDocument number as displayed to users.
generation_datestring (date-time)Date the document was generated.
number_datestring (date-time)Date used for the document number.
messagestringMessage printed on the document.
currencystringCurrency of the document.
namestringName of the document.
due_datestring (date-time)Due date of the document.
netto_valuenumber (float)Net total of the document.
brutto_valuenumber (float)Gross total of the document.
tax_valuenumber (float)Total tax amount of the document.
taxTaxrequiredTax rate applied to the document.
linked_number_titlestringTitle of the linked document number.
linked_numberstringNumber of the linked document.
statusstringStatus of the document.
previous_statusstringStatus before the last change.
status_updatedstring (date-time)Point in time the status was last changed.
archivedbooleanWhether the document is archived.
last_pdf_exportstring (date-time)Point in time the PDF was last exported.
last_status_exportstringStatus at the last export.
search_stringstringText that the entity can be searched by.
accounting_typeAccountingTyperequiredAccounting type of the invoice.
payment_typePaymentTypePayment type of the invoice.
payment_goalPaymentGoalPayment term of the invoice.
expense_categoryExpenseCategory10EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
buyerInvoiceBuyer25Buyer of the invoice.
payment_datestring (date-time)Date the invoice was paid.
vat_categorystringDer umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_servicebooleanThe payment date comes from an external service.
direct_debit_exportedbooleanThe invoice was exported for direct debit.
cancel_datestring (date-time)Date the invoice was canceled.
cancel_textstringText of the cancellation.
start_datestring (date-time)Start of the billed period.
end_datestring (date-time)End of the billed period.
performing_personCRMPerson10CRM person who leads the booking.
Show fields (81)
idintegerPrimary key of the person. Internal ID.
first_namestringFirst name of the person.
last_namestringLast name of the person.
numberintegerMember or customer number of the person.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringMember or customer number as text, including prefix.
genderstringGender of the person.
titlestringAcademic or other title of the person.
positionstringPosition or role of the person.
languagestringPreferred language of the person.
special_salutationstringSpecial salutation text for letters.
form_of_salutationstringForm of salutation, for example formal or informal.
birthdaystring (date-time)Birthday of the person.
known_allergiesstringKnown allergies of the person.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanPhotos of the person may be taken and published.
allow_leaving_alonebooleanThe person may leave the event alone.
authorized_pickupstringPersons who are allowed to pick up the person.
needs_supportbooleanThe person needs support, for example for inclusion.
support_descriptionstringDescription of the support the person needs.
financial_supportbooleanThe person receives financial support.
financial_support_numberstringNumber of the financial support.
municipal_supportbooleanThe person receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the person.
school_classstringSchool class of the person.
start_timestring (date-time)Start of the membership or activity.
start_time_reasonstringReason for the start.
end_timestring (date-time)End of the membership or activity.
end_time_reasonstringReason for the end.
confirmed_gtc_timestring (date-time)Time the general terms and conditions were confirmed.
chatbot_opt_inbooleanEinwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
chatbot_opt_in_atstring (date-time)Time the person opted in to the chatbot.
chatbot_opt_in_text_versionstringVersion des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
app_usage_statistics_opt_outbooleanWiderspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
crm_person_contact_dataarray<CRMPersonContactData>Contact data of the person, for example phone and e-mail.
archivedbooleanWhether the person is archived.
subscribed_newsletterbooleanWhether the person subscribed to the newsletter.
subscribed_magazinebooleanWhether the person subscribed to the magazine.
printed_member_cardbooleanWhether a member card has been printed for the person.
has_login_userbooleanWhether the person has a login user.
profile_picture_urlstringURL of the profile picture of the person.
log_book_staffbooleanLog book flag: staff.
log_book_staff1booleanLog book flag: staff, level 1.
log_book_staff2booleanLog book flag: staff, level 2.
log_book_memberbooleanLog book flag: member.
log_book_trainerbooleanLog book flag: trainer.
log_book_trainer1booleanLog book flag: trainer, level 1.
log_book_trainer2booleanLog book flag: trainer, level 2.
log_book_head_of_departmentbooleanLog book flag: head of department.
log_book_supervisory_boardbooleanLog book flag: supervisory board.
log_book_board_of_directorsbooleanLog book flag: board of directors.
log_book_honorary_memberbooleanLog book flag: honorary member.
log_book_club_card_onebooleanLog book flag: club card.
log_book_health_recoveredbooleanLog book flag: recovered from illness.
log_book_health_vaccinatedbooleanLog book flag: vaccinated.
log_book_health_vaccinated_additionstringDetails of the vaccination.
log_book_good_conductbooleanLog book flag: certificate of good conduct.
log_book_first_aidbooleanLog book flag: first aid training.
log_book_measles_vaccinationbooleanLog book flag: measles vaccination.
sync_lanistabooleanWhether the person is synchronized with Lanista.
categoryCRMPersonCategoryPerson category.
nicknamestringNickname of the person.
preferred_color_hexstringPreferred color of the person as hex value.
avatar_tokenstringToken of the avatar image.
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)Point in time the entity was created.
- … 2 more fields
secondary_performing_personCRMPerson10Second CRM person who leads the booking.
Show fields (68)
idintegerPrimary key of the person. Internal ID.
first_namestringFirst name of the person.
last_namestringLast name of the person.
numberintegerMember or customer number of the person.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringMember or customer number as text, including prefix.
genderstringGender of the person.
titlestringAcademic or other title of the person.
positionstringPosition or role of the person.
languagestringPreferred language of the person.
special_salutationstringSpecial salutation text for letters.
form_of_salutationstringForm of salutation, for example formal or informal.
birthdaystring (date-time)Birthday of the person.
known_allergiesstringKnown allergies of the person.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanPhotos of the person may be taken and published.
allow_leaving_alonebooleanThe person may leave the event alone.
authorized_pickupstringPersons who are allowed to pick up the person.
needs_supportbooleanThe person needs support, for example for inclusion.
support_descriptionstringDescription of the support the person needs.
financial_supportbooleanThe person receives financial support.
financial_support_numberstringNumber of the financial support.
municipal_supportbooleanThe person receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the person.
school_classstringSchool class of the person.
start_timestring (date-time)Start of the membership or activity.
start_time_reasonstringReason for the start.
end_timestring (date-time)End of the membership or activity.
end_time_reasonstringReason for the end.
confirmed_gtc_timestring (date-time)Time the general terms and conditions were confirmed.
chatbot_opt_inbooleanEinwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
chatbot_opt_in_atstring (date-time)Time the person opted in to the chatbot.
chatbot_opt_in_text_versionstringVersion des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
app_usage_statistics_opt_outbooleanWiderspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
crm_person_contact_dataarray<CRMPersonContactData>Contact data of the person, for example phone and e-mail.
archivedbooleanWhether the person is archived.
subscribed_newsletterbooleanWhether the person subscribed to the newsletter.
subscribed_magazinebooleanWhether the person subscribed to the magazine.
printed_member_cardbooleanWhether a member card has been printed for the person.
has_login_userbooleanWhether the person has a login user.
profile_picture_urlstringURL of the profile picture of the person.
log_book_staffbooleanLog book flag: staff.
log_book_staff1booleanLog book flag: staff, level 1.
log_book_staff2booleanLog book flag: staff, level 2.
log_book_memberbooleanLog book flag: member.
log_book_trainerbooleanLog book flag: trainer.
log_book_trainer1booleanLog book flag: trainer, level 1.
log_book_trainer2booleanLog book flag: trainer, level 2.
log_book_head_of_departmentbooleanLog book flag: head of department.
log_book_supervisory_boardbooleanLog book flag: supervisory board.
log_book_board_of_directorsbooleanLog book flag: board of directors.
log_book_honorary_memberbooleanLog book flag: honorary member.
log_book_club_card_onebooleanLog book flag: club card.
log_book_health_recoveredbooleanLog book flag: recovered from illness.
log_book_health_vaccinatedbooleanLog book flag: vaccinated.
log_book_health_vaccinated_additionstringDetails of the vaccination.
log_book_good_conductbooleanLog book flag: certificate of good conduct.
log_book_first_aidbooleanLog book flag: first aid training.
log_book_measles_vaccinationbooleanLog book flag: measles vaccination.
sync_lanistabooleanWhether the person is synchronized with Lanista.
categoryCRMPersonCategoryPerson category.
nicknamestringNickname of the person.
preferred_color_hexstringPreferred color of the person as hex value.
avatar_tokenstringToken of the avatar image.
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
- … 15 more fields
- … 36 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_booking_check_overlaps \
--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_booking_check_overlaps', 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_booking_check_overlaps"
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_booking_check_overlaps', [
'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_booking_check_overlaps"),
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_booking_check_overlaps")
.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_booking_check_overlaps"
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_booking_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 EventBaseBookingController.checkOverlaps(startTime: DateTime.fromJson({}), endTime: DateTime.fromJson({}), bookableIds: [42]);
if (result.success) {
print(result.data);
}[
{
"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 calendar feed of bookings
GET/api/event/base_booking_calendar/{anonymized}
Path parameters
anonymizedrequiredstring |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_booking_calendar/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_booking_calendar/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_booking_calendar/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_booking_calendar/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_booking_calendar/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_booking_calendar/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_booking_calendar/42"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.get(
Uri.parse('https://your-instance.iw-erp.de/api/event/base_booking_calendar/42'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);Get all BaseBooking for a customer
GET/api/event/base_booking_customer
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Get all BaseBooking for a customerarray<BaseBooking8>
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 42 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_booking_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_booking_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_booking_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_booking_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_booking_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_booking_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_booking_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 package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.get(
Uri.parse('https://your-instance.iw-erp.de/api/event/base_booking_customer'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);[
{
"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 the bookings of the given bookables within the given period for the booking-calendar widget.
GET/api/event/base_booking_customer_calendar
Privacy: only non-deleted bookings are returned. A booking whose event is public returns its real name and a minimal event reference. Every other booking (a plain block or a non-public event) is anonymized to the name "Block" and carries no participant / performing-person / description data.
Query parameters
startTimerequiredstring | ISO8601 start of the window |
endTimerequiredstring | ISO8601 end of the window |
bookableIdsrequiredstring | Comma separated list of bookable ids |
Responses
default
curl --request GET \
--url 'https://your-instance.iw-erp.de/api/event/base_booking_customer_calendar?startTime=string&endTime=string&bookableIds=string' \
--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_booking_customer_calendar?startTime=string&endTime=string&bookableIds=string', 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_booking_customer_calendar?startTime=string&endTime=string&bookableIds=string"
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_booking_customer_calendar?startTime=string&endTime=string&bookableIds=string', [
'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_booking_customer_calendar?startTime=string&endTime=string&bookableIds=string"),
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_booking_customer_calendar?startTime=string&endTime=string&bookableIds=string")
.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_booking_customer_calendar?startTime=string&endTime=string&bookableIds=string"
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_booking_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 EventBaseBookingController.getAllForBookableCalendar(startTime: DateTime.fromJson({}), endTime: DateTime.fromJson({}), bookableIds: [42]);
if (result.success) {
print(result.data);
}Get all BaseBooking for a customer that is the participant
GET/api/event/base_booking_customer_participant
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Get all BaseBooking for a customer that is the participantarray<BaseBooking8>
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 42 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_booking_customer_participant \
--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_booking_customer_participant', 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_booking_customer_participant"
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_booking_customer_participant', [
'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_booking_customer_participant"),
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_booking_customer_participant")
.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_booking_customer_participant"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.get(
Uri.parse('https://your-instance.iw-erp.de/api/event/base_booking_customer_participant'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);[
{
"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"
}
]Get all BaseBooking for a customer that is the performing person
GET/api/event/base_booking_customer_performing
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Get all BaseBooking for a customer that is the performing personarray<BaseBooking8>
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 42 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_booking_customer_performing \
--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_booking_customer_performing', 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_booking_customer_performing"
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_booking_customer_performing', [
'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_booking_customer_performing"),
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_booking_customer_performing")
.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_booking_customer_performing"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.get(
Uri.parse('https://your-instance.iw-erp.de/api/event/base_booking_customer_performing'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);[
{
"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"
}
]Get waitlist positions for BaseBooking for a customer
GET/api/event/base_booking_customer_waitlist_position
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Get waitlist positions for BaseBooking for a customerarray<BaseBooking8>
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 42 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_booking_customer_waitlist_position \
--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_booking_customer_waitlist_position', 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_booking_customer_waitlist_position"
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_booking_customer_waitlist_position', [
'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_booking_customer_waitlist_position"),
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_booking_customer_waitlist_position")
.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_booking_customer_waitlist_position"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.get(
Uri.parse('https://your-instance.iw-erp.de/api/event/base_booking_customer_waitlist_position'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);[
{
"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"
}
]Get booking participants (signups) and waitlist positions for a customer's bookings.
GET/api/event/base_booking_customer_booking_participants
Returns both booking_participants (grouped by booking ID) and waitlist_positions in a single response.
Query parameters
personstring | Filter by person identifier |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
default
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_booking_customer_booking_participants \
--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_booking_customer_booking_participants', 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_booking_customer_booking_participants"
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_booking_customer_booking_participants', [
'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_booking_customer_booking_participants"),
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_booking_customer_booking_participants")
.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_booking_customer_booking_participants"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.get(
Uri.parse('https://your-instance.iw-erp.de/api/event/base_booking_customer_booking_participants'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);Get a single BaseBooking for a customer
GET/api/event/base_booking_customer/{bookingId}
Path parameters
bookingIdrequiredstring |
Responses
200Get a single BaseBooking for a customerBaseBooking8
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 42 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/base_booking_customer/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_booking_customer/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_booking_customer/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_booking_customer/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_booking_customer/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_booking_customer/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_booking_customer/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_booking_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 EventBaseBookingController.getCustomer('42');
if (result.success) {
print(result.data);
}{
"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"
}Creates a single BaseBooking for a BaseBookable as a customer
POST/api/event/customer/base_booking
Request body application/json
dataBaseBooking24Show fields (8)
deletedbooleanThis property is used to mark an entity as deleted / archived
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
Responses
200Creates a single BaseBooking for a BaseBookable as a customerBaseBooking9
Show fields (17)
companyCRMCompanyShow fields (55)
idintegerPrimary key of the company. Internal ID.
short_namestringShort name of the company.
company_namestringLegal name of the company.
secondary_namestringSecond name line of the company.
direct_dialstringDirect dial number of the company.
invoice_emailstringE-mail address for invoices.
send_invoice_emailbooleanSend invoices by e-mail.
send_invoice_letterbooleanSend invoices by letter.
time_report_emailstringE-mail address for time reports.
payment_goalPaymentGoalPayment term of the company.
payment_intervalstringInterval of the payments.
vatidstringVAT identification number.
taxnumberstringTax number of the company.
buyer_reference_idstringLeitweg-ID or custom reference ID defined by the customer
taxTaxTax rate used for the company.
infostringInformation about the company.
numberstringCustomer or supplier number of the company.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringCompany number as text, including prefix.
is_customerbooleanThe company is a customer.
is_supplierbooleanThe company is a supplier.
is_otherbooleanThe company is neither customer nor supplier.
is_memberbooleanThe company is a member.
archivedbooleanThe company is archived.
categoryCRMCompanyCategoryCategory of the company.
visible_for_customerbooleanWhether the company is visible to the customer.
founding_datestring (date-time)Founding date of the company.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
payment_typePaymentTypecompany_employee_countintegerNumber of employees of the company.
company_founding_yearintegerFounding year of the company.
company_family_ownedbooleanWhether the company is family-owned.
company_sales_volumestringSales volume of the company.
company_segmentstringMarket segment of the company.
idintegerPrimary key of the booking. Internal ID.
start_timestring (date-time)Start of the booking.
end_timestring (date-time)End of the booking.
booking_typestringType of the booking, for example normal or substitution.
booking_statusstringStatus of the booking, for example planned, done or cancelled.
auto_invoicebooleanInvoices for this booking are created automatically.
waitingbooleanThe booking is on the waiting list.
confirmedbooleanThe booking is confirmed.
externalbooleanThe booking was made by an external party.
deletion_reasonstringReason the booking was cancelled.
deletion_datestring (date-time)When the booking was cancelled, set by setDeleted() - null while active and for bookings cancelled before this field existed
billedbooleanThe booking was billed.
invoiceInvoice27Invoice the booking was billed on.
Show fields (38)
idintegerPrimary key of the invoice document. Internal ID.
tokenstringToken that identifies the document for public access.
numberintegerRunning document number.
manual_number_prefixstringPrefix of a manually entered document number.
manual_numberintegerManually entered document number.
number_stringstringDocument number as displayed to users.
generation_datestring (date-time)Date the document was generated.
number_datestring (date-time)Date used for the document number.
messagestringMessage printed on the document.
currencystringCurrency of the document.
namestringName of the document.
due_datestring (date-time)Due date of the document.
netto_valuenumber (float)Net total of the document.
brutto_valuenumber (float)Gross total of the document.
tax_valuenumber (float)Total tax amount of the document.
taxTaxrequiredTax rate applied to the document.
linked_number_titlestringTitle of the linked document number.
linked_numberstringNumber of the linked document.
statusstringStatus of the document.
previous_statusstringStatus before the last change.
status_updatedstring (date-time)Point in time the status was last changed.
archivedbooleanWhether the document is archived.
last_pdf_exportstring (date-time)Point in time the PDF was last exported.
last_status_exportstringStatus at the last export.
search_stringstringText that the entity can be searched by.
accounting_typeAccountingTyperequiredAccounting type of the invoice.
payment_typePaymentTypePayment type of the invoice.
payment_goalPaymentGoalPayment term of the invoice.
expense_categoryExpenseCategory10EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
buyerInvoiceBuyer26Buyer of the invoice.
payment_datestring (date-time)Date the invoice was paid.
vat_categorystringDer umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_servicebooleanThe payment date comes from an external service.
direct_debit_exportedbooleanThe invoice was exported for direct debit.
cancel_datestring (date-time)Date the invoice was canceled.
cancel_textstringText of the cancellation.
start_datestring (date-time)Start of the billed period.
end_datestring (date-time)End of the billed period.
performing_personCRMPerson10CRM person who leads the booking.
Show fields (81)
idintegerPrimary key of the person. Internal ID.
first_namestringFirst name of the person.
last_namestringLast name of the person.
numberintegerMember or customer number of the person.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringMember or customer number as text, including prefix.
genderstringGender of the person.
titlestringAcademic or other title of the person.
positionstringPosition or role of the person.
languagestringPreferred language of the person.
special_salutationstringSpecial salutation text for letters.
form_of_salutationstringForm of salutation, for example formal or informal.
birthdaystring (date-time)Birthday of the person.
known_allergiesstringKnown allergies of the person.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanPhotos of the person may be taken and published.
allow_leaving_alonebooleanThe person may leave the event alone.
authorized_pickupstringPersons who are allowed to pick up the person.
needs_supportbooleanThe person needs support, for example for inclusion.
support_descriptionstringDescription of the support the person needs.
financial_supportbooleanThe person receives financial support.
financial_support_numberstringNumber of the financial support.
municipal_supportbooleanThe person receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the person.
school_classstringSchool class of the person.
start_timestring (date-time)Start of the membership or activity.
start_time_reasonstringReason for the start.
end_timestring (date-time)End of the membership or activity.
end_time_reasonstringReason for the end.
confirmed_gtc_timestring (date-time)Time the general terms and conditions were confirmed.
chatbot_opt_inbooleanEinwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
chatbot_opt_in_atstring (date-time)Time the person opted in to the chatbot.
chatbot_opt_in_text_versionstringVersion des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
app_usage_statistics_opt_outbooleanWiderspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
crm_person_contact_dataarray<CRMPersonContactData>Contact data of the person, for example phone and e-mail.
archivedbooleanWhether the person is archived.
subscribed_newsletterbooleanWhether the person subscribed to the newsletter.
subscribed_magazinebooleanWhether the person subscribed to the magazine.
printed_member_cardbooleanWhether a member card has been printed for the person.
has_login_userbooleanWhether the person has a login user.
profile_picture_urlstringURL of the profile picture of the person.
log_book_staffbooleanLog book flag: staff.
log_book_staff1booleanLog book flag: staff, level 1.
log_book_staff2booleanLog book flag: staff, level 2.
log_book_memberbooleanLog book flag: member.
log_book_trainerbooleanLog book flag: trainer.
log_book_trainer1booleanLog book flag: trainer, level 1.
log_book_trainer2booleanLog book flag: trainer, level 2.
log_book_head_of_departmentbooleanLog book flag: head of department.
log_book_supervisory_boardbooleanLog book flag: supervisory board.
log_book_board_of_directorsbooleanLog book flag: board of directors.
log_book_honorary_memberbooleanLog book flag: honorary member.
log_book_club_card_onebooleanLog book flag: club card.
log_book_health_recoveredbooleanLog book flag: recovered from illness.
log_book_health_vaccinatedbooleanLog book flag: vaccinated.
log_book_health_vaccinated_additionstringDetails of the vaccination.
log_book_good_conductbooleanLog book flag: certificate of good conduct.
log_book_first_aidbooleanLog book flag: first aid training.
log_book_measles_vaccinationbooleanLog book flag: measles vaccination.
sync_lanistabooleanWhether the person is synchronized with Lanista.
categoryCRMPersonCategoryPerson category.
nicknamestringNickname of the person.
preferred_color_hexstringPreferred color of the person as hex value.
avatar_tokenstringToken of the avatar image.
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)Point in time the entity was created.
- … 2 more fields
secondary_performing_personCRMPerson10Second CRM person who leads the booking.
Show fields (12)
idintegerPrimary key of the person. Internal ID.
first_namestringFirst name of the person.
last_namestringLast name of the person.
numberintegerMember or customer number of the person.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringMember or customer number as text, including prefix.
genderstringGender of the person.
titlestringAcademic or other title of the person.
positionstringPosition or role of the person.
languagestringPreferred language of the person.
special_salutationstringSpecial salutation text for letters.
- … 71 more fields
- … 36 more fields
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/customer/base_booking \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
payment_bic: 'BYLADEM1001',
payment_iban: 'DE02120300000000202051',
deleted: true,
payment_owner: 'string',
payment_institution: 'string',
payment_mandate: '2026-10-15T09:30:00+02:00'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/customer/base_booking', 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/customer/base_booking"
payload = { "data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": True,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
} }
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/customer/base_booking', [
'body' => '{"data":{"payment_bic":"BYLADEM1001","payment_iban":"DE02120300000000202051","deleted":true,"payment_owner":"string","payment_institution":"string","payment_mandate":"2026-10-15T09:30:00+02:00"}}',
'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/customer/base_booking"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
{
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\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/customer/base_booking")
.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/customer/base_booking"
payload := strings.NewReader("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
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_booking_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_booking.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingController.postCustomer(EventBaseBooking.fromJson({
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}));
if (result.success) {
print(result.data);
}{
"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"
}Creates a single BaseBooking for a BaseBookable as a guest
POST/api/event/public/base_booking
Request body application/json
dataBaseBooking24Show fields (8)
deletedbooleanThis property is used to mark an entity as deleted / archived
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
Responses
200Creates a single BaseBooking for a BaseBookable as a guestBaseBooking9
Show fields (17)
companyCRMCompanyShow fields (55)
idintegerPrimary key of the company. Internal ID.
short_namestringShort name of the company.
company_namestringLegal name of the company.
secondary_namestringSecond name line of the company.
direct_dialstringDirect dial number of the company.
invoice_emailstringE-mail address for invoices.
send_invoice_emailbooleanSend invoices by e-mail.
send_invoice_letterbooleanSend invoices by letter.
time_report_emailstringE-mail address for time reports.
payment_goalPaymentGoalPayment term of the company.
payment_intervalstringInterval of the payments.
vatidstringVAT identification number.
taxnumberstringTax number of the company.
buyer_reference_idstringLeitweg-ID or custom reference ID defined by the customer
taxTaxTax rate used for the company.
infostringInformation about the company.
numberstringCustomer or supplier number of the company.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringCompany number as text, including prefix.
is_customerbooleanThe company is a customer.
is_supplierbooleanThe company is a supplier.
is_otherbooleanThe company is neither customer nor supplier.
is_memberbooleanThe company is a member.
archivedbooleanThe company is archived.
categoryCRMCompanyCategoryCategory of the company.
visible_for_customerbooleanWhether the company is visible to the customer.
founding_datestring (date-time)Founding date of the company.
nace_sectionstringNACE section code (letter A-U)
nace_codestringNACE code (numeric like 01.11, 62.01)
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
payment_typePaymentTypecompany_employee_countintegerNumber of employees of the company.
company_founding_yearintegerFounding year of the company.
company_family_ownedbooleanWhether the company is family-owned.
company_sales_volumestringSales volume of the company.
company_segmentstringMarket segment of the company.
idintegerPrimary key of the booking. Internal ID.
start_timestring (date-time)Start of the booking.
end_timestring (date-time)End of the booking.
booking_typestringType of the booking, for example normal or substitution.
booking_statusstringStatus of the booking, for example planned, done or cancelled.
auto_invoicebooleanInvoices for this booking are created automatically.
waitingbooleanThe booking is on the waiting list.
confirmedbooleanThe booking is confirmed.
externalbooleanThe booking was made by an external party.
deletion_reasonstringReason the booking was cancelled.
deletion_datestring (date-time)When the booking was cancelled, set by setDeleted() - null while active and for bookings cancelled before this field existed
billedbooleanThe booking was billed.
invoiceInvoice27Invoice the booking was billed on.
Show fields (38)
idintegerPrimary key of the invoice document. Internal ID.
tokenstringToken that identifies the document for public access.
numberintegerRunning document number.
manual_number_prefixstringPrefix of a manually entered document number.
manual_numberintegerManually entered document number.
number_stringstringDocument number as displayed to users.
generation_datestring (date-time)Date the document was generated.
number_datestring (date-time)Date used for the document number.
messagestringMessage printed on the document.
currencystringCurrency of the document.
namestringName of the document.
due_datestring (date-time)Due date of the document.
netto_valuenumber (float)Net total of the document.
brutto_valuenumber (float)Gross total of the document.
tax_valuenumber (float)Total tax amount of the document.
taxTaxrequiredTax rate applied to the document.
linked_number_titlestringTitle of the linked document number.
linked_numberstringNumber of the linked document.
statusstringStatus of the document.
previous_statusstringStatus before the last change.
status_updatedstring (date-time)Point in time the status was last changed.
archivedbooleanWhether the document is archived.
last_pdf_exportstring (date-time)Point in time the PDF was last exported.
last_status_exportstringStatus at the last export.
search_stringstringText that the entity can be searched by.
accounting_typeAccountingTyperequiredAccounting type of the invoice.
payment_typePaymentTypePayment type of the invoice.
payment_goalPaymentGoalPayment term of the invoice.
expense_categoryExpenseCategory10EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
buyerInvoiceBuyer26Buyer of the invoice.
payment_datestring (date-time)Date the invoice was paid.
vat_categorystringDer umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_servicebooleanThe payment date comes from an external service.
direct_debit_exportedbooleanThe invoice was exported for direct debit.
cancel_datestring (date-time)Date the invoice was canceled.
cancel_textstringText of the cancellation.
start_datestring (date-time)Start of the billed period.
end_datestring (date-time)End of the billed period.
performing_personCRMPerson10CRM person who leads the booking.
Show fields (81)
idintegerPrimary key of the person. Internal ID.
first_namestringFirst name of the person.
last_namestringLast name of the person.
numberintegerMember or customer number of the person.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringMember or customer number as text, including prefix.
genderstringGender of the person.
titlestringAcademic or other title of the person.
positionstringPosition or role of the person.
languagestringPreferred language of the person.
special_salutationstringSpecial salutation text for letters.
form_of_salutationstringForm of salutation, for example formal or informal.
birthdaystring (date-time)Birthday of the person.
known_allergiesstringKnown allergies of the person.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanPhotos of the person may be taken and published.
allow_leaving_alonebooleanThe person may leave the event alone.
authorized_pickupstringPersons who are allowed to pick up the person.
needs_supportbooleanThe person needs support, for example for inclusion.
support_descriptionstringDescription of the support the person needs.
financial_supportbooleanThe person receives financial support.
financial_support_numberstringNumber of the financial support.
municipal_supportbooleanThe person receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the person.
school_classstringSchool class of the person.
start_timestring (date-time)Start of the membership or activity.
start_time_reasonstringReason for the start.
end_timestring (date-time)End of the membership or activity.
end_time_reasonstringReason for the end.
confirmed_gtc_timestring (date-time)Time the general terms and conditions were confirmed.
chatbot_opt_inbooleanEinwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
chatbot_opt_in_atstring (date-time)Time the person opted in to the chatbot.
chatbot_opt_in_text_versionstringVersion des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
app_usage_statistics_opt_outbooleanWiderspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
crm_person_contact_dataarray<CRMPersonContactData>Contact data of the person, for example phone and e-mail.
archivedbooleanWhether the person is archived.
subscribed_newsletterbooleanWhether the person subscribed to the newsletter.
subscribed_magazinebooleanWhether the person subscribed to the magazine.
printed_member_cardbooleanWhether a member card has been printed for the person.
has_login_userbooleanWhether the person has a login user.
profile_picture_urlstringURL of the profile picture of the person.
log_book_staffbooleanLog book flag: staff.
log_book_staff1booleanLog book flag: staff, level 1.
log_book_staff2booleanLog book flag: staff, level 2.
log_book_memberbooleanLog book flag: member.
log_book_trainerbooleanLog book flag: trainer.
log_book_trainer1booleanLog book flag: trainer, level 1.
log_book_trainer2booleanLog book flag: trainer, level 2.
log_book_head_of_departmentbooleanLog book flag: head of department.
log_book_supervisory_boardbooleanLog book flag: supervisory board.
log_book_board_of_directorsbooleanLog book flag: board of directors.
log_book_honorary_memberbooleanLog book flag: honorary member.
log_book_club_card_onebooleanLog book flag: club card.
log_book_health_recoveredbooleanLog book flag: recovered from illness.
log_book_health_vaccinatedbooleanLog book flag: vaccinated.
log_book_health_vaccinated_additionstringDetails of the vaccination.
log_book_good_conductbooleanLog book flag: certificate of good conduct.
log_book_first_aidbooleanLog book flag: first aid training.
log_book_measles_vaccinationbooleanLog book flag: measles vaccination.
sync_lanistabooleanWhether the person is synchronized with Lanista.
categoryCRMPersonCategoryPerson category.
nicknamestringNickname of the person.
preferred_color_hexstringPreferred color of the person as hex value.
avatar_tokenstringToken of the avatar image.
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)Point in time the entity was created.
- … 2 more fields
secondary_performing_personCRMPerson10Second CRM person who leads the booking.
Show fields (12)
idintegerPrimary key of the person. Internal ID.
first_namestringFirst name of the person.
last_namestringLast name of the person.
numberintegerMember or customer number of the person.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringMember or customer number as text, including prefix.
genderstringGender of the person.
titlestringAcademic or other title of the person.
positionstringPosition or role of the person.
languagestringPreferred language of the person.
special_salutationstringSpecial salutation text for letters.
- … 71 more fields
- … 36 more fields
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/public/base_booking \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
payment_bic: 'BYLADEM1001',
payment_iban: 'DE02120300000000202051',
deleted: true,
payment_owner: 'string',
payment_institution: 'string',
payment_mandate: '2026-10-15T09:30:00+02:00'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/public/base_booking', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/public/base_booking"
payload = { "data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": True,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
} }
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/public/base_booking', [
'body' => '{"data":{"payment_bic":"BYLADEM1001","payment_iban":"DE02120300000000202051","deleted":true,"payment_owner":"string","payment_institution":"string","payment_mandate":"2026-10-15T09:30:00+02:00"}}',
'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/public/base_booking"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
{
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\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/public/base_booking")
.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/public/base_booking"
payload := strings.NewReader("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
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_booking_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_booking.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingController.postPublic(EventBaseBooking.fromJson({
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}));
if (result.success) {
print(result.data);
}{
"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"
}Test adding a new BaseBooking as customer / public
POST/api/event/public/test_base_booking
Responses
200Test adding a new BaseBooking as customer / publicBaseBookingTest
Show fields (4)
booking_allowedbooleanbooking_waitlist_allowedbooleanbooking_explicitly_disabledbooleanbooking_requires_loginboolean
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/public/test_base_booking \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/public/test_base_booking', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/public/test_base_booking"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, 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/public/test_base_booking', [
'headers' => [
'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/public/test_base_booking"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/public/test_base_booking")
.post(null)
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/public/test_base_booking"
req, _ := http.NewRequest("POST", 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_booking_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_booking.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingController.postPublicTest(EventBaseBooking.fromJson({}));
if (result.success) {
print(result.data);
}{
"booking_allowed": true,
"booking_waitlist_allowed": true,
"booking_explicitly_disabled": true,
"booking_requires_login": true
}Returns a list of public deleted BaseBooking
GET/api/event/public/deleted_event_bookings
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Returns a list of public deleted BaseBookingarray<BaseBooking10>
Show fields (15)
idintegerPrimary key of the booking. Internal ID.
start_timestring (date-time)Start of the booking.
end_timestring (date-time)End of the booking.
booking_typestringType of the booking, for example normal or substitution.
booking_statusstringStatus of the booking, for example planned, done or cancelled.
externalbooleanThe booking was made by an external party.
performing_personCRMPerson10CRM person who leads the booking.
Show fields (81)
idintegerPrimary key of the person. Internal ID.
first_namestringFirst name of the person.
last_namestringLast name of the person.
numberintegerMember or customer number of the person.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringMember or customer number as text, including prefix.
genderstringGender of the person.
titlestringAcademic or other title of the person.
positionstringPosition or role of the person.
languagestringPreferred language of the person.
special_salutationstringSpecial salutation text for letters.
form_of_salutationstringForm of salutation, for example formal or informal.
birthdaystring (date-time)Birthday of the person.
known_allergiesstringKnown allergies of the person.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanPhotos of the person may be taken and published.
allow_leaving_alonebooleanThe person may leave the event alone.
authorized_pickupstringPersons who are allowed to pick up the person.
needs_supportbooleanThe person needs support, for example for inclusion.
support_descriptionstringDescription of the support the person needs.
financial_supportbooleanThe person receives financial support.
financial_support_numberstringNumber of the financial support.
municipal_supportbooleanThe person receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the person.
school_classstringSchool class of the person.
start_timestring (date-time)Start of the membership or activity.
start_time_reasonstringReason for the start.
end_timestring (date-time)End of the membership or activity.
end_time_reasonstringReason for the end.
confirmed_gtc_timestring (date-time)Time the general terms and conditions were confirmed.
chatbot_opt_inbooleanEinwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
chatbot_opt_in_atstring (date-time)Time the person opted in to the chatbot.
chatbot_opt_in_text_versionstringVersion des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
app_usage_statistics_opt_outbooleanWiderspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
crm_person_contact_dataarray<CRMPersonContactData>Contact data of the person, for example phone and e-mail.
archivedbooleanWhether the person is archived.
subscribed_newsletterbooleanWhether the person subscribed to the newsletter.
subscribed_magazinebooleanWhether the person subscribed to the magazine.
printed_member_cardbooleanWhether a member card has been printed for the person.
has_login_userbooleanWhether the person has a login user.
profile_picture_urlstringURL of the profile picture of the person.
log_book_staffbooleanLog book flag: staff.
log_book_staff1booleanLog book flag: staff, level 1.
log_book_staff2booleanLog book flag: staff, level 2.
log_book_memberbooleanLog book flag: member.
log_book_trainerbooleanLog book flag: trainer.
log_book_trainer1booleanLog book flag: trainer, level 1.
log_book_trainer2booleanLog book flag: trainer, level 2.
log_book_head_of_departmentbooleanLog book flag: head of department.
log_book_supervisory_boardbooleanLog book flag: supervisory board.
log_book_board_of_directorsbooleanLog book flag: board of directors.
log_book_honorary_memberbooleanLog book flag: honorary member.
log_book_club_card_onebooleanLog book flag: club card.
log_book_health_recoveredbooleanLog book flag: recovered from illness.
log_book_health_vaccinatedbooleanLog book flag: vaccinated.
log_book_health_vaccinated_additionstringDetails of the vaccination.
log_book_good_conductbooleanLog book flag: certificate of good conduct.
log_book_first_aidbooleanLog book flag: first aid training.
log_book_measles_vaccinationbooleanLog book flag: measles vaccination.
sync_lanistabooleanWhether the person is synchronized with Lanista.
categoryCRMPersonCategoryPerson category.
nicknamestringNickname of the person.
preferred_color_hexstringPreferred color of the person as hex value.
avatar_tokenstringToken of the avatar image.
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)Point in time the entity was created.
- … 2 more fields
secondary_performing_personCRMPerson10Second CRM person who leads the booking.
Show fields (81)
idintegerPrimary key of the person. Internal ID.
first_namestringFirst name of the person.
last_namestringLast name of the person.
numberintegerMember or customer number of the person.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringMember or customer number as text, including prefix.
genderstringGender of the person.
titlestringAcademic or other title of the person.
positionstringPosition or role of the person.
languagestringPreferred language of the person.
special_salutationstringSpecial salutation text for letters.
form_of_salutationstringForm of salutation, for example formal or informal.
birthdaystring (date-time)Birthday of the person.
known_allergiesstringKnown allergies of the person.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanPhotos of the person may be taken and published.
allow_leaving_alonebooleanThe person may leave the event alone.
authorized_pickupstringPersons who are allowed to pick up the person.
needs_supportbooleanThe person needs support, for example for inclusion.
support_descriptionstringDescription of the support the person needs.
financial_supportbooleanThe person receives financial support.
financial_support_numberstringNumber of the financial support.
municipal_supportbooleanThe person receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the person.
school_classstringSchool class of the person.
start_timestring (date-time)Start of the membership or activity.
start_time_reasonstringReason for the start.
end_timestring (date-time)End of the membership or activity.
end_time_reasonstringReason for the end.
confirmed_gtc_timestring (date-time)Time the general terms and conditions were confirmed.
chatbot_opt_inbooleanEinwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
chatbot_opt_in_atstring (date-time)Time the person opted in to the chatbot.
chatbot_opt_in_text_versionstringVersion des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
app_usage_statistics_opt_outbooleanWiderspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
crm_person_contact_dataarray<CRMPersonContactData>Contact data of the person, for example phone and e-mail.
archivedbooleanWhether the person is archived.
subscribed_newsletterbooleanWhether the person subscribed to the newsletter.
subscribed_magazinebooleanWhether the person subscribed to the magazine.
printed_member_cardbooleanWhether a member card has been printed for the person.
has_login_userbooleanWhether the person has a login user.
profile_picture_urlstringURL of the profile picture of the person.
log_book_staffbooleanLog book flag: staff.
log_book_staff1booleanLog book flag: staff, level 1.
log_book_staff2booleanLog book flag: staff, level 2.
log_book_memberbooleanLog book flag: member.
log_book_trainerbooleanLog book flag: trainer.
log_book_trainer1booleanLog book flag: trainer, level 1.
log_book_trainer2booleanLog book flag: trainer, level 2.
log_book_head_of_departmentbooleanLog book flag: head of department.
log_book_supervisory_boardbooleanLog book flag: supervisory board.
log_book_board_of_directorsbooleanLog book flag: board of directors.
log_book_honorary_memberbooleanLog book flag: honorary member.
log_book_club_card_onebooleanLog book flag: club card.
log_book_health_recoveredbooleanLog book flag: recovered from illness.
log_book_health_vaccinatedbooleanLog book flag: vaccinated.
log_book_health_vaccinated_additionstringDetails of the vaccination.
log_book_good_conductbooleanLog book flag: certificate of good conduct.
log_book_first_aidbooleanLog book flag: first aid training.
log_book_measles_vaccinationbooleanLog book flag: measles vaccination.
sync_lanistabooleanWhether the person is synchronized with Lanista.
categoryCRMPersonCategoryPerson category.
nicknamestringNickname of the person.
preferred_color_hexstringPreferred color of the person as hex value.
avatar_tokenstringToken of the avatar image.
search_stringstringText that the entity can be searched by.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
createdstring (date-time)Point in time the entity was created.
- … 2 more fields
modified_timebooleanThe time of the booking was changed after it was created.
modified_locationbooleanThe location of the booking was changed after it was created.
modified_bookablebooleanThe bookable of the booking was changed after it was created.
modified_performing_personbooleanThe leader of the booking was changed after it was created.
searching_for_performing_personbooleanA leader for the booking is still being searched for.
third_performing_personCRMPerson10Show fields (27)
idintegerPrimary key of the person. Internal ID.
first_namestringFirst name of the person.
last_namestringLast name of the person.
numberintegerMember or customer number of the person.
manual_numberintegerNumber set manually instead of the automatic number.
number_stringstringMember or customer number as text, including prefix.
genderstringGender of the person.
titlestringAcademic or other title of the person.
positionstringPosition or role of the person.
languagestringPreferred language of the person.
special_salutationstringSpecial salutation text for letters.
form_of_salutationstringForm of salutation, for example formal or informal.
birthdaystring (date-time)Birthday of the person.
known_allergiesstringKnown allergies of the person.
confirmed_no_allergiesbooleanGuardian confirmed that there are no known allergies.
allow_photosbooleanPhotos of the person may be taken and published.
allow_leaving_alonebooleanThe person may leave the event alone.
authorized_pickupstringPersons who are allowed to pick up the person.
needs_supportbooleanThe person needs support, for example for inclusion.
support_descriptionstringDescription of the support the person needs.
financial_supportbooleanThe person receives financial support.
financial_support_numberstringNumber of the financial support.
municipal_supportbooleanThe person receives municipal support.
municipal_support_numberstringNumber of the municipal support.
grade_levelintegerSchool grade level of the person.
school_classstringSchool class of the person.
- … 56 more fields
- … 8 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/public/deleted_event_bookings \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/public/deleted_event_bookings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/public/deleted_event_bookings"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/public/deleted_event_bookings', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/public/deleted_event_bookings"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/public/deleted_event_bookings")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/public/deleted_event_bookings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-iw-jwt-token", "<TOKEN>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}Dart with package:http (no controller in the iw_erp_api package)
import 'package:http/http.dart' as http;
final response = await http.get(
Uri.parse('https://your-instance.iw-erp.de/api/event/public/deleted_event_bookings'),
headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);[
{
"id": 42,
"name": "Beispiel",
"color": "#3f5efb",
"fg_color": "#3f5efb",
"start_time": "2026-10-15T09:30:00+02:00",
"end_time": "2026-10-15T09:30:00+02:00",
"booking_type": "string",
"booking_status": "string",
"external": true,
"performing_person": {
"id": 42,
"first_name": "Lena",
"last_name": "Hartmann",
"title": "Beispiel",
"language": "de",
"support_description": "Text",
"profile_picture_url": "https://vynst.de",
"address_street": "Jakobistr. 39",
"address_city": "Hannover",
"address_zip": "30163"
}
}
]Get all BaseBooking for a BaseBookable where performingPerson can be self-assigned
GET/api/event/public/self_assign_bookings_for_bookable/{baseBookableIdentifier}
Path parameters
baseBookableIdentifierrequiredstring |
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Get all BaseBooking for a BaseBookable where performingPerson can be self-assignedarray<BaseBooking8>
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 42 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/public/self_assign_bookings_for_bookable/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/public/self_assign_bookings_for_bookable/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/public/self_assign_bookings_for_bookable/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/public/self_assign_bookings_for_bookable/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/public/self_assign_bookings_for_bookable/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/public/self_assign_bookings_for_bookable/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/public/self_assign_bookings_for_bookable/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_booking_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 EventBaseBookingController.getAllAllowedSelfAssignForBookable('42');
if (result.success) {
print(result.data);
}[
{
"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 BaseBooking where performingPerson can be self-assigned
GET/api/event/public/self_assign_bookings/{identifier}
Path parameters
identifierrequiredstring |
Responses
200Returns a single BaseBooking where performingPerson can be self-assignedBaseBooking8
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 42 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/public/self_assign_bookings/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/public/self_assign_bookings/42', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.iw-erp.de/api/event/public/self_assign_bookings/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/public/self_assign_bookings/42', [
'headers' => [
'x-iw-jwt-token' => '<TOKEN>',
],
]);
echo $response->getBody();using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/public/self_assign_bookings/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/public/self_assign_bookings/42")
.get()
.addHeader("x-iw-jwt-token", "<TOKEN>")
.build();
Response response = client.newCall(request).execute();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.iw-erp.de/api/event/public/self_assign_bookings/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_booking_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 EventBaseBookingController.getSelfAssignable('42');
if (result.success) {
print(result.data);
}{
"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"
}Cancel a booking by trainer (sets deleted=true with INSTRUCTOR_CANCELLED reason)
POST/api/event/trainer_actions/base_booking/cancel/{bookingIdentifier}
Path parameters
bookingIdentifierrequiredstring |
Query parameters
suppressNotificationboolean | If true, no automatic cancellation notification is sent for this cancellation. |
Responses
default
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/trainer_actions/base_booking/cancel/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/trainer_actions/base_booking/cancel/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/trainer_actions/base_booking/cancel/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.post(url, 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/trainer_actions/base_booking/cancel/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.Post,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/trainer_actions/base_booking/cancel/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/trainer_actions/base_booking/cancel/42")
.post(null)
.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/trainer_actions/base_booking/cancel/42"
req, _ := http.NewRequest("POST", 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_booking_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 EventBaseBookingController.postTrainerCancelBooking('42');
if (result.success) {
print(result.data);
}Lists the own availabilities of the logged in person.
GET/api/event/self_service/own_availability
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Lists the own availabilities of the logged in personarray<BaseBooking11>
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 44 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/self_service/own_availability \
--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/self_service/own_availability', 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/self_service/own_availability"
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/self_service/own_availability', [
'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/self_service/own_availability"),
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/self_service/own_availability")
.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/self_service/own_availability"
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_booking_availability_self_service_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 EventBaseBookingAvailabilitySelfServiceController.getOwnAvailabilities();
if (result.success) {
print(result.data);
}[
{
"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"
}
]Creates an availability for the logged in person.
POST/api/event/self_service/own_availability
Request body application/json
dataBaseBooking24Show fields (8)
deletedbooleanThis property is used to mark an entity as deleted / archived
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
Responses
200Creates an availability for the logged in personBaseBooking11
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 44 more fields
curl --request POST \
--url https://your-instance.iw-erp.de/api/event/self_service/own_availability \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}
}
'const options = {
method: 'POST',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
payment_bic: 'BYLADEM1001',
payment_iban: 'DE02120300000000202051',
deleted: true,
payment_owner: 'string',
payment_institution: 'string',
payment_mandate: '2026-10-15T09:30:00+02:00'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/self_service/own_availability', 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/self_service/own_availability"
payload = { "data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": True,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
} }
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/self_service/own_availability', [
'body' => '{"data":{"payment_bic":"BYLADEM1001","payment_iban":"DE02120300000000202051","deleted":true,"payment_owner":"string","payment_institution":"string","payment_mandate":"2026-10-15T09:30:00+02:00"}}',
'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/self_service/own_availability"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
{
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\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/self_service/own_availability")
.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/self_service/own_availability"
payload := strings.NewReader("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
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_booking_availability_self_service_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_booking.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingAvailabilitySelfServiceController.postOwnAvailability(EventBaseBooking.fromJson({
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}));
if (result.success) {
print(result.data);
}{
"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"
}Updates an availability of the logged in person.
PUT/api/event/self_service/own_availability/{identifier}
Path parameters
identifierrequiredstring |
Request body application/json
dataBaseBooking24Show fields (8)
deletedbooleanThis property is used to mark an entity as deleted / archived
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
Responses
200Updates an availability of the logged in personBaseBooking11
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 44 more fields
curl --request PUT \
--url https://your-instance.iw-erp.de/api/event/self_service/own_availability/42 \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}
}
'const options = {
method: 'PUT',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
payment_bic: 'BYLADEM1001',
payment_iban: 'DE02120300000000202051',
deleted: true,
payment_owner: 'string',
payment_institution: 'string',
payment_mandate: '2026-10-15T09:30:00+02:00'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/self_service/own_availability/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/self_service/own_availability/42"
payload = { "data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": True,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
} }
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/self_service/own_availability/42', [
'body' => '{"data":{"payment_bic":"BYLADEM1001","payment_iban":"DE02120300000000202051","deleted":true,"payment_owner":"string","payment_institution":"string","payment_mandate":"2026-10-15T09:30:00+02:00"}}',
'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/self_service/own_availability/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
{
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\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/self_service/own_availability/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/self_service/own_availability/42"
payload := strings.NewReader("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
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_booking_availability_self_service_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_booking.dart';
IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';
final result = await EventBaseBookingAvailabilitySelfServiceController.putOwnAvailability(EventBaseBooking.fromJson({
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}));
if (result.success) {
print(result.data);
}{
"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"
}Updates an availability of the logged in person.
PATCH/api/event/self_service/own_availability/{identifier}
Path parameters
identifierrequiredstring |
Request body application/json
dataBaseBooking24Show fields (8)
deletedbooleanThis property is used to mark an entity as deleted / archived
payment_ownerstringAccount owner of the direct debit.
payment_institutionstringName of the bank of the direct debit.
payment_bicstringBIC of the bank account.
payment_ibanstringIBAN of the bank account.
payment_mandatestringReference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)Date until which the SEPA mandate is valid.
Responses
200Updates an availability of the logged in personBaseBooking11
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 44 more fields
curl --request PATCH \
--url https://your-instance.iw-erp.de/api/event/self_service/own_availability/42 \
--header 'content-type: application/json' \
--header 'x-iw-jwt-token: <TOKEN>' \
--data '
{
"data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}
}
'const options = {
method: 'PATCH',
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: JSON.stringify({
data: {
payment_bic: 'BYLADEM1001',
payment_iban: 'DE02120300000000202051',
deleted: true,
payment_owner: 'string',
payment_institution: 'string',
payment_mandate: '2026-10-15T09:30:00+02:00'
}
})
};
fetch('https://your-instance.iw-erp.de/api/event/self_service/own_availability/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/self_service/own_availability/42"
payload = { "data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": True,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
} }
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/self_service/own_availability/42', [
'body' => '{"data":{"payment_bic":"BYLADEM1001","payment_iban":"DE02120300000000202051","deleted":true,"payment_owner":"string","payment_institution":"string","payment_mandate":"2026-10-15T09:30:00+02:00"}}',
'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/self_service/own_availability/42"),
Headers =
{
{ "x-iw-jwt-token", "<TOKEN>" },
},
Content = new StringContent("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
{
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\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}");
Request request = new Request.Builder()
.url("https://your-instance.iw-erp.de/api/event/self_service/own_availability/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/self_service/own_availability/42"
payload := strings.NewReader("{\"data\":{\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"deleted\":true,\"payment_owner\":\"string\",\"payment_institution\":\"string\",\"payment_mandate\":\"2026-10-15T09:30:00+02:00\"}}")
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/self_service/own_availability/42'),
headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
body: jsonEncode({
"data": {
"payment_bic": "BYLADEM1001",
"payment_iban": "DE02120300000000202051",
"deleted": true,
"payment_owner": "string",
"payment_institution": "string",
"payment_mandate": "2026-10-15T09:30:00+02:00"
}
}),
);
print(response.body);{
"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"
}Cancels an availability of the logged in person. Bookings that already picked the availability keep their trainer - the availability is only the offer, not the appointment itself.
DELETE/api/event/self_service/own_availability/{identifier}
Path parameters
identifierrequiredstring |
Responses
200Cancels an availability of the logged in personBaseBooking11
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 44 more fields
curl --request DELETE \
--url https://your-instance.iw-erp.de/api/event/self_service/own_availability/42 \
--header 'x-iw-jwt-token: <TOKEN>'const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};
fetch('https://your-instance.iw-erp.de/api/event/self_service/own_availability/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/self_service/own_availability/42"
headers = {"x-iw-jwt-token": "<TOKEN>"}
response = requests.delete(url, headers=headers)
print(response.text)<?php
require_once('vendor/autoload.php');
$client = new \GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/event/self_service/own_availability/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.Delete,
RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/self_service/own_availability/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/self_service/own_availability/42")
.delete(null)
.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/self_service/own_availability/42"
req, _ := http.NewRequest("DELETE", 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_booking_availability_self_service_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 EventBaseBookingAvailabilitySelfServiceController.deleteOwnAvailability('42');
if (result.success) {
print(result.data);
}{
"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"
}Calendar of all availabilities, gated by the visibility setting event_trainer_availability_visibility_type.
GET/api/event/self_service/availability_calendar
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Calendar of all visible availabilitiesarray<BaseBooking11>
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 44 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/self_service/availability_calendar \
--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/self_service/availability_calendar', 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/self_service/availability_calendar"
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/self_service/availability_calendar', [
'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/self_service/availability_calendar"),
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/self_service/availability_calendar")
.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/self_service/availability_calendar"
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_booking_availability_self_service_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 EventBaseBookingAvailabilitySelfServiceController.getAvailabilityCalendar();
if (result.success) {
print(result.data);
}[
{
"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"
}
]The availabilities that can be picked as the trainer of a self service object booking for the given period. Availabilities whose trainer is already booked in that period are left out.
GET/api/event/self_service/availability_options
Query parameters
deletedboolean | This property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST |
baseLocationstring | Requires access right: PUBLIC_LIST |
baseEventstring | Requires access right: PUBLIC_LIST |
baseBookablestring | Requires access right: PUBLIC_LIST |
secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
baseBookable---secondaryBaseBookablestring | Requires access right: PUBLIC_LIST |
userstring | Requires access right: PUBLIC_LIST |
startTimestring | Requires access right: PUBLIC_LIST |
endTimestring | Requires access right: PUBLIC_LIST |
colorstring | Requires access right: PUBLIC_LIST |
billedboolean | Requires access right: PUBLIC_LIST |
waitingboolean | Requires access right: PUBLIC_LIST |
bookingTypestring | Requires access right: PUBLIC_LIST |
contentTypestring | Requires access right: PUBLIC_LIST |
bookingStatusstring | Requires access right: PUBLIC_LIST |
addonData_publicDeletedstring | Requires access right: PUBLIC_LIST |
addonData_addressAutoCompleteTypestring | Requires access right: PUBLIC_LIST |
eventTypestring | denormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Selectable trainer availabilities for a booking periodarray<BaseBooking11>
Show fields (5)
baseLocationBaseLocation10Show fields (29)
idintegerPrimary key of the location. Internal ID.
tokenstringPublic token of the location. Used in links instead of the ID.
location_typestringType of the location, for example room, hall or outdoor area.
in_contact_centerbooleanThe 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
is_ui_filterbooleanThis property is used to mark an entity as a filter for the frontend
baseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
secondaryBaseBookableBaseBookable10Show fields (50)
ticketSeatingPlanIdintegerId of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation10idintegerPrimary key of the bookable. Internal ID.
tokenstringPublic token of the bookable. Used in links instead of the ID.
bookable_typestringType of the bookable, for example room, court or vehicle.
floor_levelstringFloor the bookable is on.
floor_sizeintegerFloor size in square meters.
pets_allowedbooleanPets are allowed.
barrier_freebooleanThe bookable is barrier-free.
cargo_volumeintegerCargo volume in liters.
fuel_typestringFuel type of the vehicle.
seating_capacityintegerNumber of seats.
has_wait_listbooleanThe bookable has a waiting list once it is fully booked.
booking_limitintegerMaximum number of bookings.
billing_modestringHow 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_userintegerMaximum 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_hoursintegerMaximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedbooleanKept 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_addressbooleanThe address must be entered when booking.
require_contactbooleanContact details must be entered when booking.
require_billingbooleanBilling details must be entered when booking.
require_booking_titlebooleanA title must be entered when booking.
allow_direct_billingbooleanrequire_agebooleanThe age must be entered when booking.
counter_update_modestringHow 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.
addressstringAddress as text.
address_streetstringStreet of the address.
address_house_numberstringHouse number of the address.
address_street_levelstringStreet and house number of the address.
address_costringCare-of line of the address.
address_citystringCity of the address.
address_zipstringPostal code of the address.
address_admin_level1stringFirst administrative level of the address, e.g. the federal state.
address_countrystringCountry code of the address.
address_full_countrystringFull name of the country of the address.
address_geo_latstringLatitude of the address.
address_geo_lngstringLongitude of the address.
address_external_provider_idstringfield to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestringMain phone number.
main_faxstringMain fax number.
main_emailstringMain e-mail address.
websitestringWebsite address.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
short_identifierstringShort identifier of the entity.
image_urlstringURL of the image of the entity.
slug_identifierstringSlug used in URLs of the entity.
baseEventBaseEvent20Show fields (68)
ticketSeatingPlanIdintegerId of the seating plan, also for the public and the customer serialization.
bib_numbers_enabledbooleantiming_enabledbooleanbaseBookableBaseBookable10secondaryBaseBookableBaseBookable10baseLocationBaseLocation10idintegerPrimary key of the event. Internal ID.
tokenstringPublic token of the event. Used in links and QR codes instead of the ID.
moments_modestringControls 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_designstringVisual theme of the moments (digital guestbook) pages and exports.
public_keywordsstringKeywords shown in the public event listing.
public_subtitlestringSubtitle shown in the public event listing.
event_typestringType of the event, for example course, trip or tournament.
age_groupstringAge group the event is intended for, for example children or adults.
min_ageintegerMinimum age in years of participants.
max_ageintegerMaximum age in years of participants.
min_age_monthsintegerMinimum age in months of participants, for events for infants.
max_age_monthsintegerMaximum age in months of participants, for events for infants.
min_grade_levelintegerMinimum school grade level of participants.
max_grade_levelintegerMaximum school grade level of participants.
age_toleranceintegerYears by which participants may be outside the age range and still sign up.
event_people_limitintegermaximum number of people that can attend the event
event_people_min_limitintegerminimum number of people that must attend the event
hide_event_people_limitbooleana setting to hide the event people limit in the frontend ui
event_people_recovered_vaccinated_limitintegerMaximum number of recovered or vaccinated participants.
event_people_not_recovered_vaccinated_limitintegerMaximum number of participants who are neither recovered nor vaccinated.
has_wait_listbooleanThe event has a waiting list once it is full.
wait_list_confirmation_requiredbooleanParticipants from the waiting list must confirm their place.
trial_enabledbooleanTrial 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_eventbooleanParticipants may sign up for the main event.
only_sign_up_for_main_eventbooleanParticipants may only sign up for the main event, not for sub-events.
sign_up_limit_days_beforeintegerNumber of days before the start until which sign-ups are possible.
sign_up_limit_stop_days_beforeintegerNumber of days before the start from which sign-ups are closed.
sign_up_delete_hours_beforeintegerHours before the start until which a participant can cancel the sign-up.
performing_personCRMPerson59CRM person who leads the event, for example the trainer.
secondary_performing_personCRMPerson59Second CRM person who leads the event.
start_timestring (date-time)Start of the event.
end_timestring (date-time)End of the event.
require_addressbooleanParticipants must enter an address when signing up.
require_contactbooleanParticipants must enter contact details when signing up.
require_billingbooleanParticipants must enter billing details when signing up.
allow_direct_billingbooleanrequire_direct_billingbooleanallow_budget_sign_upbooleanrequire_agebooleanParticipants must enter their age when signing up.
require_grade_levelbooleanParticipants must enter their school grade level when signing up.
require_free_note_field_idsstringIDs of the free note fields that participants must fill in.
generate_new_bookingsbooleanBookings are generated automatically for the event schedule.
generate_new_bookings_v2booleanBookings are generated with the second version of the schedule generator.
generate_ignore_sys_calendarbooleanGenerated bookings ignore the holidays of the system calendar.
copy_main_sign_ups_to_bookingbooleanSign-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_weekintegerWeekday for generated bookings.
bitmask_days_of_weekintegerThis is a bitmask value of the days of the week the event occurs on
bitmask_hours_startintegerThis is a bitmask value of the hours an event starts on
summarized_date_timesstringThis is a string with the days and hours an event starts on
customer_detail_ctastringCall-to-action text shown in the customer app on the event detail page.
customer_badgestringBadge text shown on the event in the customer app.
bib_number_modestringVergabeart 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_bystringWertung nach Netto- (NET) oder Bruttozeit (GROSS).
timing_min_lap_secondsintegerGleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.
timing_public_livebooleanLive timing results are public.
timing_gps_trackingbooleanGPS tracking of participants is enabled for timing.
timing_self_check_inbooleanParticipants can check in themselves for timing.
scoreboard_enabledbooleanScoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.
- … 37 more fields
- … 44 more fields
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/self_service/availability_options \
--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/self_service/availability_options', 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/self_service/availability_options"
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/self_service/availability_options', [
'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/self_service/availability_options"),
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/self_service/availability_options")
.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/self_service/availability_options"
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_booking_availability_self_service_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 EventBaseBookingAvailabilitySelfServiceController.getAvailabilityOptions(startTime: '…', endTime: '…');
if (result.success) {
print(result.data);
}[
{
"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"
}
]The content types a self service booking may be created with. Returns an empty list for every installation that did not flag any content type, which is what keeps the existing self service booking screens unchanged.
GET/api/event/self_service/booking_content_types
Query parameters
idinteger | |
deletedboolean | This property is used to mark an entity as deleted / archived |
namestring | |
shortNamestring | Kurzname for compact UI labels (e.g. calendars, badges). |
appointmentboolean | |
availabilityboolean | |
colorstring | |
selfServiceSelectableboolean | Whether this content type may be picked by a customer / trainer in the self service portal. Off by default so existing installations keep the current behaviour. |
trainerAvailabilityModestring | Controls whether a self service booking of this content type also picks the availability of a trainer: NONE (default), OPTIONAL or REQUIRED. |
createdstring | |
searchStringstring | text to search for in the list |
orderFieldNamestring | name of the order field |
orderFieldSortstring | sorting modeAllowed: DESCASC |
pageinteger | page of the list |
pageSizeinteger | number of entries for each page |
withMaxPageNumberstring | returns the number of pages available as a header if this is set |
Responses
200Content types selectable in the self service bookingarray<BookingContentType>
Show fields (22)
idintegerPrimary key of the content type. Internal ID.
short_namestringKurzname for compact UI labels (e.g. calendars, badges).
provide_tagsstringTags the content type provides, for example qualifications taught.
require_tagsstringTags a trainer or resource needs to have for this content type.
required_qualificationEmploymentQualification6R05/L18: the qualification a performing person of appointments of this type should hold (Übungsleiter of a course, Pausenaufsicht, ...). Checked with the same group/ ranking rules as shifts; employee and linked trainer qualifications both count.
Show fields (7)
idintegerPrimary key of the employment qualification. Internal ID.
rankingintegerRanking within an equivalence network - a linked qualification with a higher or equal ranking also satisfies requirements for this qualification.
equivalent_qualificationsarray<EmploymentQualification6>Linked ("equivalent") qualifications. Kept symmetric by the controller: every link A->B is mirrored as B->A, the ranking decides which direction actually covers which.
qualification_groupEmploymentQualificationGroupL17/A06: the "drawer" this qualification belongs to. Members of one group cover each other's requirements within their ranking, like a direct link would.
search_stringstringText that the entity can be searched by.
deletedbooleanThis property is used to mark an entity as deleted / archived
namestringName of the entity.
qualification_match_modestringHow the required tags are matched against the qualifications.
availabilitybooleanBookings of this content type mark the resource as available.
appointmentbooleanBookings of this content type are appointments.
colorBookingPredefinedColorPredefined color used for bookings of this content type.
Show fields (13)
idintegerPrimary key of the color. Internal ID.
colorstringColor value, for example a hex code.
default_for_availabilitybooleanDefault color for availability bookings.
default_for_appointmentbooleanDefault color for appointments.
default_for_blockingbooleanDefault color for blocking bookings.
availabilitybooleanThe color can be used for availability bookings.
appointmentbooleanThe color can be used for appointments.
blockingbooleanThe color can be used for blocking bookings.
search_stringstringText that the entity can be searched by.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
require_single_participantbooleanBookings of this content type need exactly one participant.
require_participant_contactbooleanParticipants of this content type must have contact details.
require_participant_addressbooleanParticipants of this content type must have an address.
require_participant_birthdaybooleanParticipants of this content type must have a birthday.
default_time_in_minutesintegerDefault length of a booking of this content type in minutes.
self_service_selectablebooleanWhether this content type may be picked by a customer / trainer in the self service portal. Off by default so existing installations keep the current behaviour.
trainer_availability_modestringControls whether a self service booking of this content type also picks the availability of a trainer: NONE (default), OPTIONAL or REQUIRED.
self_service_bookable_typesarray<BaseBookableBookableType>Restricts the bookable types this content type is offered for in the self service booking. An empty collection means "every bookable type".
Show fields (11)
idstringIdentifier of the bookable type. For example room or vehicle.
short_namestringKurzname for compact UI labels (e.g. calendars, badges).
namestringName of the bookable type.
view_orderintegerSort order of the bookable type in lists.
menu_namestringName of the menu entry for the bookable type.
menu_iconstringIcon of the menu entry for the bookable type.
show_admin_menubooleanShow the bookable type in the admin menu.
show_admin_calendarbooleanShow the bookable type in the admin calendar.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
deletedbooleanThis property is used to mark an entity as deleted / archived
search_stringstringText that the entity can be searched by.
createdstring (date-time)Point in time the entity was created.
updatedstring (date-time)Point in time the entity was last updated.
namestringName of the entity.
deletedbooleanThis property is used to mark an entity as deleted / archived
curl --request GET \
--url https://your-instance.iw-erp.de/api/event/self_service/booking_content_types \
--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/self_service/booking_content_types', 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/self_service/booking_content_types"
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/self_service/booking_content_types', [
'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/self_service/booking_content_types"),
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/self_service/booking_content_types")
.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/self_service/booking_content_types"
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_booking_availability_self_service_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 EventBaseBookingAvailabilitySelfServiceController.getSelfServiceContentTypes();
if (result.success) {
print(result.data);
}[
{
"id": 42,
"short_name": "Beispiel",
"color": {
"id": 42,
"color": "#3f5efb",
"name": "Beispiel",
"default_for_availability": true,
"default_for_appointment": true,
"default_for_blocking": true,
"availability": true,
"appointment": true,
"blocking": true,
"search_string": "string"
},
"name": "Beispiel",
"provide_tags": "string",
"require_tags": "string",
"required_qualification": {
"id": 42,
"name": "Beispiel",
"ranking": 1,
"search_string": "string",
"deleted": true
},
"qualification_match_mode": "string",
"availability": true,
"appointment": true
}
]