Skip to content
Developer

Booking

Locations and bookings34 EndpointsEvent / Booking

Returns a list of BaseBooking

GET/api/event/base_booking

Query parameters

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Returns a list of BaseBookingarray<BaseBooking3>

Show fields (18)
  • companyCRMCompany
    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • userUser14
    Show fields (10)
    • idinteger

      Primary key of the user. Internal ID of the login user.

    • namestring

      Display name of the user. Shown in the UI and in audit entries.

    • usernamestring

      Login name of the user. Must be unique across all users.

    • emailstring

      E-mail address of the user. Used for login notifications, password resets and as a login alias.

    • positioningeneralstring

      Free text describing the position or role of the user.

    • crm_personCRMPerson10

      CRM person linked to this login user. Connects the login account with the person record.

    • profile_picture_urlstring

      URL of the profile picture of the user.

    • archivedboolean

      Marks the user as archived. Archived users are kept for history and are not active.

    • require2faboolean

      Two-factor authentication is required for this user.

    • search_stringstring

      Text that the entity can be searched by.

  • idinteger

    Primary key of the booking. Internal ID.

  • start_timestring (date-time)

    Start of the booking.

  • end_timestring (date-time)

    End of the booking.

  • booking_typestring

    Type of the booking, for example normal or substitution.

  • booking_statusstring

    Status of the booking, for example planned, done or cancelled.

  • auto_invoiceboolean

    Invoices for this booking are created automatically.

  • waitingboolean

    The booking is on the waiting list.

  • confirmedboolean

    The booking is confirmed.

  • externalboolean

    The booking was made by an external party.

  • deletion_reasonstring

    Reason 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

  • billedboolean

    The booking was billed.

  • invoiceInvoice23

    Invoice the booking was billed on.

    Show fields (38)
    • idinteger

      Primary key of the invoice document. Internal ID.

    • tokenstring

      Token that identifies the document for public access.

    • numberinteger

      Running document number.

    • manual_number_prefixstring

      Prefix of a manually entered document number.

    • manual_numberinteger

      Manually entered document number.

    • number_stringstring

      Document number as displayed to users.

    • generation_datestring (date-time)

      Date the document was generated.

    • number_datestring (date-time)

      Date used for the document number.

    • messagestring

      Message printed on the document.

    • currencystring

      Currency of the document.

    • namestring

      Name 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.

    • taxTaxrequired

      Tax rate applied to the document.

    • linked_number_titlestring

      Title of the linked document number.

    • linked_numberstring

      Number of the linked document.

    • statusstring

      Status of the document.

    • previous_statusstring

      Status before the last change.

    • status_updatedstring (date-time)

      Point in time the status was last changed.

    • archivedboolean

      Whether the document is archived.

    • last_pdf_exportstring (date-time)

      Point in time the PDF was last exported.

    • last_status_exportstring

      Status at the last export.

    • search_stringstring

      Text that the entity can be searched by.

    • accounting_typeAccountingTyperequired

      Accounting type of the invoice.

    • payment_typePaymentType

      Payment type of the invoice.

    • payment_goalPaymentGoal

      Payment term of the invoice.

    • expense_categoryExpenseCategory10

      EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet

    • buyerInvoiceBuyer22

      Buyer of the invoice.

    • payment_datestring (date-time)

      Date the invoice was paid.

    • vat_categorystring

      Der 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_serviceboolean

      The payment date comes from an external service.

    • direct_debit_exportedboolean

      The invoice was exported for direct debit.

    • cancel_datestring (date-time)

      Date the invoice was canceled.

    • cancel_textstring

      Text of the cancellation.

    • start_datestring (date-time)

      Start of the billed period.

    • end_datestring (date-time)

      End of the billed period.

  • performing_personCRMPerson10

    CRM person who leads the booking.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung 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_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch 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.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • secondary_performing_personCRMPerson10

    Second CRM person who leads the booking.

    Show fields (1)
    • … 82 more fields
  • … 36 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Creates a single BaseBooking

POST/api/event/base_booking

Request body application/json

  • dataBaseBooking24
    Show fields (8)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference 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)
  • companyCRMCompany
    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent18
    Show fields (12)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • … 91 more fields
  • … 52 more fields
Request
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"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Returns a single BaseBooking

GET/api/event/base_booking/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single BaseBookingBaseBooking5

Show fields (6)
  • companyCRMCompany
    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent18
    Show fields (12)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • … 91 more fields
  • … 52 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Updates a single BaseBooking

PUT/api/event/base_booking/{identifier}

Path parameters

identifierrequiredstring

Query parameters

suppressNotificationbooleanIf true and this update cancels the booking (deleted=true), no automatic cancellation notification is sent for this action.

Request body application/json

  • dataBaseBooking24
    Show fields (8)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference 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)
  • companyCRMCompany
    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent18
    Show fields (12)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • … 91 more fields
  • … 52 more fields
Request
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"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Updates a single BaseBooking

PATCH/api/event/base_booking/{identifier}

Path parameters

identifierrequiredstring

Query parameters

suppressNotificationbooleanIf true and this update cancels the booking (deleted=true), no automatic cancellation notification is sent for this action.

Request body application/json

  • dataBaseBooking24
    Show fields (8)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference 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)
  • companyCRMCompany
    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent18
    Show fields (12)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • … 91 more fields
  • … 52 more fields
Request
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"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Deletes a single BaseBooking

DELETE/api/event/base_booking/{identifier}

Path parameters

identifierrequiredstring

Responses

200Deletes a single BaseBookingBaseBooking5

Show fields (6)
  • companyCRMCompany
    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent18
    Show fields (12)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • … 91 more fields
  • … 52 more fields
Request
curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/event/base_booking/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Test a new BaseBooking

POST/api/event/base_booking_test

Responses

200Test a new BaseBookingBaseBooking2

Show fields (5)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent13
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson10

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson10

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 42 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_booking_test \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

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)
  • companyCRMCompany
    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent18
    Show fields (12)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • … 91 more fields
  • … 53 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_booking/42/adds/attachments \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

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)
  • companyCRMCompany
    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent18
    Show fields (12)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • … 91 more fields
  • … 53 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_booking/42/removes/attachments \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Updates an existing field in multiple bookings entry.

POST/api/event/base_booking_update_multi

Responses

default

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_booking_update_multi \
  --header 'x-iw-jwt-token: <TOKEN>'

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

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns 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)
  • idinteger

    Primary key of the booking. Internal ID.

  • start_timestring (date-time)

    Start of the booking.

  • end_timestring (date-time)

    End of the booking.

  • booking_typestring

    Type of the booking, for example normal or substitution.

  • booking_statusstring

    Status of the booking, for example planned, done or cancelled.

  • auto_invoiceboolean

    Invoices for this booking are created automatically.

  • waitingboolean

    The booking is on the waiting list.

  • confirmedboolean

    The booking is confirmed.

  • externalboolean

    The booking was made by an external party.

  • deletion_reasonstring

    Reason 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

  • billedboolean

    The booking was billed.

  • invoiceInvoice26

    Invoice the booking was billed on.

    Show fields (38)
    • idinteger

      Primary key of the invoice document. Internal ID.

    • tokenstring

      Token that identifies the document for public access.

    • numberinteger

      Running document number.

    • manual_number_prefixstring

      Prefix of a manually entered document number.

    • manual_numberinteger

      Manually entered document number.

    • number_stringstring

      Document number as displayed to users.

    • generation_datestring (date-time)

      Date the document was generated.

    • number_datestring (date-time)

      Date used for the document number.

    • messagestring

      Message printed on the document.

    • currencystring

      Currency of the document.

    • namestring

      Name 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.

    • taxTaxrequired

      Tax rate applied to the document.

    • linked_number_titlestring

      Title of the linked document number.

    • linked_numberstring

      Number of the linked document.

    • statusstring

      Status of the document.

    • previous_statusstring

      Status before the last change.

    • status_updatedstring (date-time)

      Point in time the status was last changed.

    • archivedboolean

      Whether the document is archived.

    • last_pdf_exportstring (date-time)

      Point in time the PDF was last exported.

    • last_status_exportstring

      Status at the last export.

    • search_stringstring

      Text that the entity can be searched by.

    • accounting_typeAccountingTyperequired

      Accounting type of the invoice.

    • payment_typePaymentType

      Payment type of the invoice.

    • payment_goalPaymentGoal

      Payment term of the invoice.

    • expense_categoryExpenseCategory10

      EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet

    • buyerInvoiceBuyer25

      Buyer of the invoice.

    • payment_datestring (date-time)

      Date the invoice was paid.

    • vat_categorystring

      Der 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_serviceboolean

      The payment date comes from an external service.

    • direct_debit_exportedboolean

      The invoice was exported for direct debit.

    • cancel_datestring (date-time)

      Date the invoice was canceled.

    • cancel_textstring

      Text of the cancellation.

    • start_datestring (date-time)

      Start of the billed period.

    • end_datestring (date-time)

      End of the billed period.

  • performing_personCRMPerson10

    CRM person who leads the booking.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung 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_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch 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.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • secondary_performing_personCRMPerson10

    Second CRM person who leads the booking.

    Show fields (68)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung 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_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch 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.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • … 15 more fields
  • … 36 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking_check_overlaps \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Returns a calendar feed of bookings

GET/api/event/base_booking_calendar/{anonymized}

Path parameters

anonymizedrequiredstring

Responses

default

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

Get all BaseBooking for a customer

GET/api/event/base_booking_customer

Query parameters

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Get all BaseBooking for a customerarray<BaseBooking8>

Show fields (5)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 42 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking_customer \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Returns 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

startTimerequiredstringISO8601 start of the window
endTimerequiredstringISO8601 end of the window
bookableIdsrequiredstringComma separated list of bookable ids

Responses

default

Request
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>'

Get all BaseBooking for a customer that is the participant

GET/api/event/base_booking_customer_participant

Query parameters

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns 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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 42 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking_customer_participant \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Get all BaseBooking for a customer that is the performing person

GET/api/event/base_booking_customer_performing

Query parameters

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns 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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 42 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking_customer_performing \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Get waitlist positions for BaseBooking for a customer

GET/api/event/base_booking_customer_waitlist_position

Query parameters

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns 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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 42 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking_customer_waitlist_position \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

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

personstringFilter by person identifier
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

default

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

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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 42 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking_customer/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Creates a single BaseBooking for a BaseBookable as a customer

POST/api/event/customer/base_booking

Request body application/json

  • dataBaseBooking24
    Show fields (8)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference 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)
  • companyCRMCompany
    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • idinteger

    Primary key of the booking. Internal ID.

  • start_timestring (date-time)

    Start of the booking.

  • end_timestring (date-time)

    End of the booking.

  • booking_typestring

    Type of the booking, for example normal or substitution.

  • booking_statusstring

    Status of the booking, for example planned, done or cancelled.

  • auto_invoiceboolean

    Invoices for this booking are created automatically.

  • waitingboolean

    The booking is on the waiting list.

  • confirmedboolean

    The booking is confirmed.

  • externalboolean

    The booking was made by an external party.

  • deletion_reasonstring

    Reason 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

  • billedboolean

    The booking was billed.

  • invoiceInvoice27

    Invoice the booking was billed on.

    Show fields (38)
    • idinteger

      Primary key of the invoice document. Internal ID.

    • tokenstring

      Token that identifies the document for public access.

    • numberinteger

      Running document number.

    • manual_number_prefixstring

      Prefix of a manually entered document number.

    • manual_numberinteger

      Manually entered document number.

    • number_stringstring

      Document number as displayed to users.

    • generation_datestring (date-time)

      Date the document was generated.

    • number_datestring (date-time)

      Date used for the document number.

    • messagestring

      Message printed on the document.

    • currencystring

      Currency of the document.

    • namestring

      Name 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.

    • taxTaxrequired

      Tax rate applied to the document.

    • linked_number_titlestring

      Title of the linked document number.

    • linked_numberstring

      Number of the linked document.

    • statusstring

      Status of the document.

    • previous_statusstring

      Status before the last change.

    • status_updatedstring (date-time)

      Point in time the status was last changed.

    • archivedboolean

      Whether the document is archived.

    • last_pdf_exportstring (date-time)

      Point in time the PDF was last exported.

    • last_status_exportstring

      Status at the last export.

    • search_stringstring

      Text that the entity can be searched by.

    • accounting_typeAccountingTyperequired

      Accounting type of the invoice.

    • payment_typePaymentType

      Payment type of the invoice.

    • payment_goalPaymentGoal

      Payment term of the invoice.

    • expense_categoryExpenseCategory10

      EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet

    • buyerInvoiceBuyer26

      Buyer of the invoice.

    • payment_datestring (date-time)

      Date the invoice was paid.

    • vat_categorystring

      Der 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_serviceboolean

      The payment date comes from an external service.

    • direct_debit_exportedboolean

      The invoice was exported for direct debit.

    • cancel_datestring (date-time)

      Date the invoice was canceled.

    • cancel_textstring

      Text of the cancellation.

    • start_datestring (date-time)

      Start of the billed period.

    • end_datestring (date-time)

      End of the billed period.

  • performing_personCRMPerson10

    CRM person who leads the booking.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung 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_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch 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.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • secondary_performing_personCRMPerson10

    Second CRM person who leads the booking.

    Show fields (12)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • … 71 more fields
  • … 36 more fields
Request
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"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Creates a single BaseBooking for a BaseBookable as a guest

POST/api/event/public/base_booking

Request body application/json

  • dataBaseBooking24
    Show fields (8)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference 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)
  • companyCRMCompany
    Show fields (55)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • idinteger

    Primary key of the booking. Internal ID.

  • start_timestring (date-time)

    Start of the booking.

  • end_timestring (date-time)

    End of the booking.

  • booking_typestring

    Type of the booking, for example normal or substitution.

  • booking_statusstring

    Status of the booking, for example planned, done or cancelled.

  • auto_invoiceboolean

    Invoices for this booking are created automatically.

  • waitingboolean

    The booking is on the waiting list.

  • confirmedboolean

    The booking is confirmed.

  • externalboolean

    The booking was made by an external party.

  • deletion_reasonstring

    Reason 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

  • billedboolean

    The booking was billed.

  • invoiceInvoice27

    Invoice the booking was billed on.

    Show fields (38)
    • idinteger

      Primary key of the invoice document. Internal ID.

    • tokenstring

      Token that identifies the document for public access.

    • numberinteger

      Running document number.

    • manual_number_prefixstring

      Prefix of a manually entered document number.

    • manual_numberinteger

      Manually entered document number.

    • number_stringstring

      Document number as displayed to users.

    • generation_datestring (date-time)

      Date the document was generated.

    • number_datestring (date-time)

      Date used for the document number.

    • messagestring

      Message printed on the document.

    • currencystring

      Currency of the document.

    • namestring

      Name 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.

    • taxTaxrequired

      Tax rate applied to the document.

    • linked_number_titlestring

      Title of the linked document number.

    • linked_numberstring

      Number of the linked document.

    • statusstring

      Status of the document.

    • previous_statusstring

      Status before the last change.

    • status_updatedstring (date-time)

      Point in time the status was last changed.

    • archivedboolean

      Whether the document is archived.

    • last_pdf_exportstring (date-time)

      Point in time the PDF was last exported.

    • last_status_exportstring

      Status at the last export.

    • search_stringstring

      Text that the entity can be searched by.

    • accounting_typeAccountingTyperequired

      Accounting type of the invoice.

    • payment_typePaymentType

      Payment type of the invoice.

    • payment_goalPaymentGoal

      Payment term of the invoice.

    • expense_categoryExpenseCategory10

      EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet

    • buyerInvoiceBuyer26

      Buyer of the invoice.

    • payment_datestring (date-time)

      Date the invoice was paid.

    • vat_categorystring

      Der 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_serviceboolean

      The payment date comes from an external service.

    • direct_debit_exportedboolean

      The invoice was exported for direct debit.

    • cancel_datestring (date-time)

      Date the invoice was canceled.

    • cancel_textstring

      Text of the cancellation.

    • start_datestring (date-time)

      Start of the billed period.

    • end_datestring (date-time)

      End of the billed period.

  • performing_personCRMPerson10

    CRM person who leads the booking.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung 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_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch 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.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • secondary_performing_personCRMPerson10

    Second CRM person who leads the booking.

    Show fields (12)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • … 71 more fields
  • … 36 more fields
Request
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"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

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_allowedboolean
  • booking_waitlist_allowedboolean
  • booking_explicitly_disabledboolean
  • booking_requires_loginboolean
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/public/test_base_booking \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "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

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Returns a list of public deleted BaseBookingarray<BaseBooking10>

Show fields (15)
  • idinteger

    Primary key of the booking. Internal ID.

  • start_timestring (date-time)

    Start of the booking.

  • end_timestring (date-time)

    End of the booking.

  • booking_typestring

    Type of the booking, for example normal or substitution.

  • booking_statusstring

    Status of the booking, for example planned, done or cancelled.

  • externalboolean

    The booking was made by an external party.

  • performing_personCRMPerson10

    CRM person who leads the booking.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung 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_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch 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.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • secondary_performing_personCRMPerson10

    Second CRM person who leads the booking.

    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung 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_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch 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.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • modified_timeboolean

    The time of the booking was changed after it was created.

  • modified_locationboolean

    The location of the booking was changed after it was created.

  • modified_bookableboolean

    The bookable of the booking was changed after it was created.

  • modified_performing_personboolean

    The leader of the booking was changed after it was created.

  • searching_for_performing_personboolean

    A leader for the booking is still being searched for.

  • third_performing_personCRMPerson10
    Show fields (27)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • … 56 more fields
  • … 8 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/public/deleted_event_bookings \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "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

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns 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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 42 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/public/self_assign_bookings_for_bookable/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Returns a single 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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 42 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/public/self_assign_bookings/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

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

suppressNotificationbooleanIf true, no automatic cancellation notification is sent for this cancellation.

Responses

default

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/trainer_actions/base_booking/cancel/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

Lists the own availabilities of the logged in person.

GET/api/event/self_service/own_availability

Query parameters

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns 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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 44 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/self_service/own_availability \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Creates an availability for the logged in person.

POST/api/event/self_service/own_availability

Request body application/json

  • dataBaseBooking24
    Show fields (8)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference 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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 44 more fields
Request
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"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Updates an availability of the logged in person.

PUT/api/event/self_service/own_availability/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataBaseBooking24
    Show fields (8)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference 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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 44 more fields
Request
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"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Updates an availability of the logged in person.

PATCH/api/event/self_service/own_availability/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataBaseBooking24
    Show fields (8)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference 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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 44 more fields
Request
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"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

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)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 44 more fields
Request
curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/event/self_service/own_availability/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "participant_company_name": "Beispiel",
  "participant_name": "Beispiel",
  "participant_first_name": "Beispiel",
  "participant_last_name": "Beispiel",
  "participant_address_zip": "30163",
  "participant_address_city": "Hannover",
  "participant_address_country": "DE",
  "participant_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Calendar of all availabilities, gated by the visibility setting event_trainer_availability_visibility_type.

GET/api/event/self_service/availability_calendar

Query parameters

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Calendar of all visible availabilitiesarray<BaseBooking11>

Show fields (5)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 44 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/self_service/availability_calendar \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

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

deletedbooleanThis property is used to mark an entity as deleted / archived | Requires access right: PUBLIC_LIST
baseLocationstringRequires access right: PUBLIC_LIST
baseEventstringRequires access right: PUBLIC_LIST
baseBookablestringRequires access right: PUBLIC_LIST
secondaryBaseBookablestringRequires access right: PUBLIC_LIST
baseBookable---secondaryBaseBookablestringRequires access right: PUBLIC_LIST
userstringRequires access right: PUBLIC_LIST
startTimestringRequires access right: PUBLIC_LIST
endTimestringRequires access right: PUBLIC_LIST
colorstringRequires access right: PUBLIC_LIST
billedbooleanRequires access right: PUBLIC_LIST
waitingbooleanRequires access right: PUBLIC_LIST
bookingTypestringRequires access right: PUBLIC_LIST
contentTypestringRequires access right: PUBLIC_LIST
bookingStatusstringRequires access right: PUBLIC_LIST
addonData_publicDeletedstringRequires access right: PUBLIC_LIST
addonData_addressAutoCompleteTypestringRequires access right: PUBLIC_LIST
eventTypestringdenormalized event type from BaseEvent for fast filtering | Requires access right: PUBLIC_LIST
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Selectable trainer availabilities for a booking periodarray<BaseBooking11>

Show fields (5)
  • baseLocationBaseLocation10
    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • baseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • secondaryBaseBookableBaseBookable10
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • baseLocationBaseLocation10
    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

      Public token of the bookable. Used in links instead of the ID.

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • baseEventBaseEvent20
    Show fields (68)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable10
    • secondaryBaseBookableBaseBookable10
    • baseLocationBaseLocation10
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • performing_personCRMPerson59

      CRM person who leads the event, for example the trainer.

    • secondary_performing_personCRMPerson59

      Second CRM person who leads the event.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • … 37 more fields
  • … 44 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/self_service/availability_options \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "participant_company_name": "Beispiel",
    "participant_name": "Beispiel",
    "participant_first_name": "Beispiel",
    "participant_last_name": "Beispiel",
    "participant_address_zip": "30163",
    "participant_address_city": "Hannover",
    "participant_address_country": "DE",
    "participant_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

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
deletedbooleanThis property is used to mark an entity as deleted / archived
namestring
shortNamestringKurzname for compact UI labels (e.g. calendars, badges).
appointmentboolean
availabilityboolean
colorstring
selfServiceSelectablebooleanWhether 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.
trainerAvailabilityModestringControls whether a self service booking of this content type also picks the availability of a trainer: NONE (default), OPTIONAL or REQUIRED.
createdstring
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns 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)
  • idinteger

    Primary key of the content type. Internal ID.

  • short_namestring

    Kurzname for compact UI labels (e.g. calendars, badges).

  • provide_tagsstring

    Tags the content type provides, for example qualifications taught.

  • require_tagsstring

    Tags a trainer or resource needs to have for this content type.

  • required_qualificationEmploymentQualification6

    R05/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)
    • idinteger

      Primary key of the employment qualification. Internal ID.

    • rankinginteger

      Ranking 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_groupEmploymentQualificationGroup

      L17/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_stringstring

      Text that the entity can be searched by.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • namestring

      Name of the entity.

  • qualification_match_modestring

    How the required tags are matched against the qualifications.

  • availabilityboolean

    Bookings of this content type mark the resource as available.

  • appointmentboolean

    Bookings of this content type are appointments.

  • colorBookingPredefinedColor

    Predefined color used for bookings of this content type.

    Show fields (13)
    • idinteger

      Primary key of the color. Internal ID.

    • colorstring

      Color value, for example a hex code.

    • default_for_availabilityboolean

      Default color for availability bookings.

    • default_for_appointmentboolean

      Default color for appointments.

    • default_for_blockingboolean

      Default color for blocking bookings.

    • availabilityboolean

      The color can be used for availability bookings.

    • appointmentboolean

      The color can be used for appointments.

    • blockingboolean

      The color can be used for blocking bookings.

    • search_stringstring

      Text 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.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • require_single_participantboolean

    Bookings of this content type need exactly one participant.

  • require_participant_contactboolean

    Participants of this content type must have contact details.

  • require_participant_addressboolean

    Participants of this content type must have an address.

  • require_participant_birthdayboolean

    Participants of this content type must have a birthday.

  • default_time_in_minutesinteger

    Default length of a booking of this content type in minutes.

  • self_service_selectableboolean

    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.

  • trainer_availability_modestring

    Controls 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)
    • idstring

      Identifier of the bookable type. For example room or vehicle.

    • short_namestring

      Kurzname for compact UI labels (e.g. calendars, badges).

    • namestring

      Name of the bookable type.

    • view_orderinteger

      Sort order of the bookable type in lists.

    • menu_namestring

      Name of the menu entry for the bookable type.

    • menu_iconstring

      Icon of the menu entry for the bookable type.

    • show_admin_menuboolean

      Show the bookable type in the admin menu.

    • show_admin_calendarboolean

      Show 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.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • search_stringstring

    Text 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.

  • namestring

    Name of the entity.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/self_service/booking_content_types \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "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
  }
]