Zum Inhalt springen
Developer

Trial (Schnuppern)

Veranstaltungen16 EndpunkteEvent / Trial (Schnuppern)

Events, bei denen die ausgewählte Person schnuppern kann, jeweils mit der Schnupper-Prüfung (verbleibende Termine, Grund wenn sie gerade nicht buchbar ist). Abfrage: person (eine Person der ausgewählten Firma, Standard ist der Benutzer).

GET/api/event/customer/trial/base_event

Query-Parameter

personintegerPerson der ausgewählten Firma

Antworten

200Liste von {event, allowed, reason, error_code, trial_max, trial_used, trial_remaining, trial_status}

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

Schnupperprüfung für ein Event und die Termine, die die ausgewählte Person als Schnuppertermine buchen kann.

GET/api/event/customer/trial/base_event/{eventIdentifier}

Pfad-Parameter

eventIdentifierPflichtstring

Query-Parameter

personintegerPerson der ausgewählten Firma

Antworten

200{allowed, reason, error_code, trial_max, trial_used, trial_remaining, trial_status, dates: [{id, name, start_time, end_time}]}

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

Bucht einen Schnupper-Termin für eine Person des ausgewählten Unternehmens. Body: data.baseBooking; query oder data.person (Standard: der Benutzer).

POST/api/event/customer/trial/base_event_signup

Request-Body application/json

  • dataobject
    Felder anzeigen (2)
    • baseBookinginteger
    • personinteger

Antworten

200Die Anmeldung zum ProbeterminBaseEventSignUp

Felder anzeigen (42)
  • idinteger

    Primärschlüssel der Anmeldung. Interne ID.

  • first_namestring

    Vorname des Teilnehmers.

  • last_namestring

    Nachname des Teilnehmers.

  • genderstring

    Geschlecht des Teilnehmers.

  • waitingboolean

    Die Anmeldung steht auf der Warteliste.

  • confirmedboolean

    Die Anmeldung ist bestätigt.

  • deletion_reasonstring

    Grund für die Stornierung der Anmeldung.

  • direct_billingboolean
  • direct_billing_check_datestring (date-time)
  • direct_billing_tokenstring
  • wait_list_confirmation_sent_atstring (date-time)
  • wait_list_confirmation_deadlinestring (date-time)
  • wait_list_confirmed_atstring (date-time)
  • wait_list_pending_confirmationboolean
  • wait_list_sort_orderinteger
  • birthdaystring (date-time)

    Geburtstag des Teilnehmers.

  • known_allergiesstring

    Bekannte Allergien des Teilnehmers.

  • confirmed_no_allergiesboolean

    Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

  • allow_photosboolean

    Erziehungsberechtigte(r) erlaubt Fotos des Teilnehmers.

  • allow_child_aloneboolean

    Teilnehmende Person darf nach der Veranstaltung allein gehen.

  • authorized_pickupstring

    Personen, die den Teilnehmer abholen dürfen.

  • needs_supportboolean

    Teilnehmende Person benötigt Unterstützung, zum Beispiel bei der Inklusion.

  • support_descriptionstring

    Beschreibung der Unterstützung, die der Teilnehmer benötigt.

  • financial_supportboolean

    Teilnehmende Person erhält eine finanzielle Förderung.

  • financial_support_numberstring

    Nummer der finanziellen Förderung, zum Beispiel eines Gutscheins.

  • municipal_supportboolean

    Teilnehmende Person erhält eine kommunale Förderung.

  • municipal_support_numberstring

    Nummer der kommunalen Förderung.

  • grade_levelinteger

    Schuljahrgang der teilnehmenden Person.

  • school_classstring

    Schulklasse der teilnehmenden Person.

  • self_check_inboolean

    Teilnehmende Person hat sich per Selbstbedienungs-Check-in eingecheckt.

  • self_check_outboolean

    Teilnehmende Person hat sich per Selbstbedienungs-Check-out ausgecheckt.

  • self_check_in_datestring (date-time)

    Zeitpunkt des Self-Service-Check-ins.

  • self_check_out_datestring (date-time)

    Zeitpunkt des Self-Service-Check-outs.

  • reminded_of_absencestring (date-time)

    Zeitpunkt, zu dem der Erziehungsberechtigte an eine Abwesenheit erinnert wurde.

  • trialboolean

    Schnuppertermin-Anmeldung (Schnuppern): eine Terminanmeldung ohne Kursplatz, die eine Einheit des Schnupper-Kontingents der Person verbraucht (eventAccessBudget mit sourceType trial)

  • trial_channelstring

    Wer den Probetermin gebucht hat: App, Trainer, Büro

  • trial_session_numberinteger

    Nummer dieses Probetermins innerhalb des Durchgangs (1 = erster), für "Schnuppern 2/3"

  • trial_session_maxinteger

    Schnuppertermine des Passes, für "Schnuppern 2/3"

  • confirmed_datestring (date-time)

    Zeitpunkt, zu dem die Anmeldung bestätigt wurde.

  • bib_numberinteger

    Startnummer (Zähler). Bei PER_PREFIX nur zusammen mit dem Präfix eindeutig. Wird nur über BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.

  • bib_labelstring

    Angezeigte Startnummer inkl. Präfix, z. B. W0123. Pro Veranstaltung eindeutig.

  • namestring

    Name der Einheit.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/customer/trial/base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "baseBooking": 1,
    "person": 1
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "support_description": "Text",
  "name": "Beispiel",
  "gender": "string",
  "waiting": true,
  "confirmed": true,
  "deletion_reason": "string",
  "direct_billing": true
}

Schnupper-Kontingente der Personen der ausgewählten Firma mit ihren Schnupperterminen - für "noch 2 von 3" und die Karte "Weiter dabei sein?" nach dem letzten Schnupptermin.

GET/api/event/customer/trial_pass

Query-Parameter

personintegerNur diese Person der ausgewählten Firma

Antworten

200Liste von {pass, event, sign_ups, hold}

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

Öffentliche Probeseite einer Veranstaltung: die Veranstaltung (über ihren Token oder per ID, wenn sie öffentlich ist), ob sie über den öffentlichen Link ausprobiert werden kann und die Termine mit Platz für eine Probeperson.

GET/api/event/public/trial/base_event/{eventIdentifier}

Pfad-Parameter

eventIdentifierPflichtstring

Antworten

200{event, allowed, reason, error_code, trial_max, dates: [{id, name, start_time, end_time}]}

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

Einen Probetermin über den öffentlichen Link anfordern. Body: data.baseBooking, firstName, lastName, birthday (YYYY-MM-DD), mainEmail (E-Mail der Eltern), mainPhone (optional), confirmedPrivacy (muss true sein).

POST/api/event/public/trial/base_event_signup/{eventIdentifier}

Noch nichts gebucht: Die Eltern erhalten per E-Mail einen Bestätigungslink (und, wenn das Kind bereits bekannt ist, die App-Benutzer des Haushalts per Push); der Termin wird bei der Bestätigung gebucht. Die Antwort verrät nicht, ob die Person bekannt ist.

Pfad-Parameter

eventIdentifierPflichtstring

Request-Body application/json

  • dataobject
    Felder anzeigen (7)
    • baseBookinginteger
    • firstNamestring
    • lastNamestring
    • birthdaystring
    • mainEmailstring
    • mainPhonestring
    • confirmedPrivacyboolean

Antworten

200{status: 'pending', main_email, expires_at}

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/public/trial/base_event_signup/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "firstName": "Lena",
    "lastName": "Hartmann",
    "baseBooking": 1,
    "birthday": "string",
    "mainEmail": "lena.hartmann@example.org",
    "mainPhone": "string"
  }
}
'

Eine öffentliche Probeanfrage über den Token ihres Bestätigungslinks: Kurs, Datum, der Name des Kindes und ob sie noch offen, bestätigt oder abgelaufen ist.

GET/api/event/public/trial/request/{token}

Pfad-Parameter

tokenPflichtstring

Antworten

200{status, expired, expires_at, first_name, last_name, course_name, start_time, end_time}

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

Eine öffentliche Schnupper-Anfrage bestätigen: Der Termin wird jetzt gebucht (alle Prüfungen laufen erneut) und die Buchungs-E-Mail wird gesendet. Eine doppelte Bestätigung liefert dieselbe Anmeldung zurück; ein abgelaufener Link wird mit 1581 abgelehnt.

POST/api/event/public/trial/request/{token}/confirm

Pfad-Parameter

tokenPflichtstring

Antworten

200Die Anmeldung zum ProbeterminBaseEventSignUp

Felder anzeigen (42)
  • idinteger

    Primärschlüssel der Anmeldung. Interne ID.

  • first_namestring

    Vorname des Teilnehmers.

  • last_namestring

    Nachname des Teilnehmers.

  • genderstring

    Geschlecht des Teilnehmers.

  • waitingboolean

    Die Anmeldung steht auf der Warteliste.

  • confirmedboolean

    Die Anmeldung ist bestätigt.

  • deletion_reasonstring

    Grund für die Stornierung der Anmeldung.

  • direct_billingboolean
  • direct_billing_check_datestring (date-time)
  • direct_billing_tokenstring
  • wait_list_confirmation_sent_atstring (date-time)
  • wait_list_confirmation_deadlinestring (date-time)
  • wait_list_confirmed_atstring (date-time)
  • wait_list_pending_confirmationboolean
  • wait_list_sort_orderinteger
  • birthdaystring (date-time)

    Geburtstag des Teilnehmers.

  • known_allergiesstring

    Bekannte Allergien des Teilnehmers.

  • confirmed_no_allergiesboolean

    Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

  • allow_photosboolean

    Erziehungsberechtigte(r) erlaubt Fotos des Teilnehmers.

  • allow_child_aloneboolean

    Teilnehmende Person darf nach der Veranstaltung allein gehen.

  • authorized_pickupstring

    Personen, die den Teilnehmer abholen dürfen.

  • needs_supportboolean

    Teilnehmende Person benötigt Unterstützung, zum Beispiel bei der Inklusion.

  • support_descriptionstring

    Beschreibung der Unterstützung, die der Teilnehmer benötigt.

  • financial_supportboolean

    Teilnehmende Person erhält eine finanzielle Förderung.

  • financial_support_numberstring

    Nummer der finanziellen Förderung, zum Beispiel eines Gutscheins.

  • municipal_supportboolean

    Teilnehmende Person erhält eine kommunale Förderung.

  • municipal_support_numberstring

    Nummer der kommunalen Förderung.

  • grade_levelinteger

    Schuljahrgang der teilnehmenden Person.

  • school_classstring

    Schulklasse der teilnehmenden Person.

  • self_check_inboolean

    Teilnehmende Person hat sich per Selbstbedienungs-Check-in eingecheckt.

  • self_check_outboolean

    Teilnehmende Person hat sich per Selbstbedienungs-Check-out ausgecheckt.

  • self_check_in_datestring (date-time)

    Zeitpunkt des Self-Service-Check-ins.

  • self_check_out_datestring (date-time)

    Zeitpunkt des Self-Service-Check-outs.

  • reminded_of_absencestring (date-time)

    Zeitpunkt, zu dem der Erziehungsberechtigte an eine Abwesenheit erinnert wurde.

  • trialboolean

    Schnuppertermin-Anmeldung (Schnuppern): eine Terminanmeldung ohne Kursplatz, die eine Einheit des Schnupper-Kontingents der Person verbraucht (eventAccessBudget mit sourceType trial)

  • trial_channelstring

    Wer den Probetermin gebucht hat: App, Trainer, Büro

  • trial_session_numberinteger

    Nummer dieses Probetermins innerhalb des Durchgangs (1 = erster), für "Schnuppern 2/3"

  • trial_session_maxinteger

    Schnuppertermine des Passes, für "Schnuppern 2/3"

  • confirmed_datestring (date-time)

    Zeitpunkt, zu dem die Anmeldung bestätigt wurde.

  • bib_numberinteger

    Startnummer (Zähler). Bei PER_PREFIX nur zusammen mit dem Präfix eindeutig. Wird nur über BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.

  • bib_labelstring

    Angezeigte Startnummer inkl. Präfix, z. B. W0123. Pro Veranstaltung eindeutig.

  • namestring

    Name der Einheit.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/public/trial/request/42/confirm \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "support_description": "Text",
  "name": "Beispiel",
  "gender": "string",
  "waiting": true,
  "confirmed": true,
  "deletion_reason": "string",
  "direct_billing": true
}

Trainer eines Termins fügt eine Schnupperperson hinzu: data.baseBooking sowie entweder data.person (eine bekannte Person) oder firstName, lastName, birthday, mainEmail, mainPhone (wird anhand von Name und Geburtstag gefunden, sonst in einem neuen Haushalt angelegt).

POST/api/event/trainer/trial/base_event_signup

Request-Body application/json

  • dataobject
    Felder anzeigen (7)
    • baseBookinginteger
    • personinteger
    • firstNamestring
    • lastNamestring
    • birthdaystring
    • mainEmailstring
    • mainPhonestring

Antworten

200Die Anmeldung zum ProbeterminBaseEventSignUp

Felder anzeigen (42)
  • idinteger

    Primärschlüssel der Anmeldung. Interne ID.

  • first_namestring

    Vorname des Teilnehmers.

  • last_namestring

    Nachname des Teilnehmers.

  • genderstring

    Geschlecht des Teilnehmers.

  • waitingboolean

    Die Anmeldung steht auf der Warteliste.

  • confirmedboolean

    Die Anmeldung ist bestätigt.

  • deletion_reasonstring

    Grund für die Stornierung der Anmeldung.

  • direct_billingboolean
  • direct_billing_check_datestring (date-time)
  • direct_billing_tokenstring
  • wait_list_confirmation_sent_atstring (date-time)
  • wait_list_confirmation_deadlinestring (date-time)
  • wait_list_confirmed_atstring (date-time)
  • wait_list_pending_confirmationboolean
  • wait_list_sort_orderinteger
  • birthdaystring (date-time)

    Geburtstag des Teilnehmers.

  • known_allergiesstring

    Bekannte Allergien des Teilnehmers.

  • confirmed_no_allergiesboolean

    Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

  • allow_photosboolean

    Erziehungsberechtigte(r) erlaubt Fotos des Teilnehmers.

  • allow_child_aloneboolean

    Teilnehmende Person darf nach der Veranstaltung allein gehen.

  • authorized_pickupstring

    Personen, die den Teilnehmer abholen dürfen.

  • needs_supportboolean

    Teilnehmende Person benötigt Unterstützung, zum Beispiel bei der Inklusion.

  • support_descriptionstring

    Beschreibung der Unterstützung, die der Teilnehmer benötigt.

  • financial_supportboolean

    Teilnehmende Person erhält eine finanzielle Förderung.

  • financial_support_numberstring

    Nummer der finanziellen Förderung, zum Beispiel eines Gutscheins.

  • municipal_supportboolean

    Teilnehmende Person erhält eine kommunale Förderung.

  • municipal_support_numberstring

    Nummer der kommunalen Förderung.

  • grade_levelinteger

    Schuljahrgang der teilnehmenden Person.

  • school_classstring

    Schulklasse der teilnehmenden Person.

  • self_check_inboolean

    Teilnehmende Person hat sich per Selbstbedienungs-Check-in eingecheckt.

  • self_check_outboolean

    Teilnehmende Person hat sich per Selbstbedienungs-Check-out ausgecheckt.

  • self_check_in_datestring (date-time)

    Zeitpunkt des Self-Service-Check-ins.

  • self_check_out_datestring (date-time)

    Zeitpunkt des Self-Service-Check-outs.

  • reminded_of_absencestring (date-time)

    Zeitpunkt, zu dem der Erziehungsberechtigte an eine Abwesenheit erinnert wurde.

  • trialboolean

    Schnuppertermin-Anmeldung (Schnuppern): eine Terminanmeldung ohne Kursplatz, die eine Einheit des Schnupper-Kontingents der Person verbraucht (eventAccessBudget mit sourceType trial)

  • trial_channelstring

    Wer den Probetermin gebucht hat: App, Trainer, Büro

  • trial_session_numberinteger

    Nummer dieses Probetermins innerhalb des Durchgangs (1 = erster), für "Schnuppern 2/3"

  • trial_session_maxinteger

    Schnuppertermine des Passes, für "Schnuppern 2/3"

  • confirmed_datestring (date-time)

    Zeitpunkt, zu dem die Anmeldung bestätigt wurde.

  • bib_numberinteger

    Startnummer (Zähler). Bei PER_PREFIX nur zusammen mit dem Präfix eindeutig. Wird nur über BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.

  • bib_labelstring

    Angezeigte Startnummer inkl. Präfix, z. B. W0123. Pro Veranstaltung eindeutig.

  • namestring

    Name der Einheit.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/trainer/trial/base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "firstName": "Lena",
    "lastName": "Hartmann",
    "baseBooking": 1,
    "person": 1,
    "birthday": "string",
    "mainEmail": "lena.hartmann@example.org"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "support_description": "Text",
  "name": "Beispiel",
  "gender": "string",
  "waiting": true,
  "confirmed": true,
  "deletion_reason": "string",
  "direct_billing": true
}

Schnupperprüfung für ein Event und eine Person, mit den Terminen, die die Person als Schnuppertermine buchen kann.

GET/api/event/trial/base_event/{eventIdentifier}/check

Pfad-Parameter

eventIdentifierPflichtstring

Query-Parameter

personPflichtintegerCRMPerson

Antworten

200{allowed, reason, error_code, trial_max, trial_used, trial_remaining, trial_status, dates}

Anfrage
curl --request GET \
  --url 'https://eure-instanz.iw-erp.de/api/event/trial/base_event/42/check?person=1' \
  --header 'x-iw-jwt-token: <TOKEN>'

Das Büro bucht einen Probetermin für eine Person. Body: data.baseBooking, data.person.

POST/api/event/trial/base_event_signup

Request-Body application/json

  • dataobject
    Felder anzeigen (2)
    • baseBookinginteger
    • personinteger

Antworten

200Die Anmeldung zum ProbeterminBaseEventSignUp7

Felder anzeigen (56)
  • bib_range_idinteger
  • ticketSeatLabelstring

    Bezeichnung des gebuchten Platzes ("Reihennummer"), für Tickets, Check-in und die Ticketübersicht.

  • age_classstring

    Altersklasse nach DLV, z. B. M40 – berechnet aus Geburtstag, Geschlecht und Veranstaltungsdatum.

  • idinteger

    Primärschlüssel der Anmeldung. Interne ID.

  • first_namestring

    Vorname des Teilnehmers.

  • last_namestring

    Nachname des Teilnehmers.

  • genderstring

    Geschlecht des Teilnehmers.

  • tokenstring

    Öffentlicher Token der Anmeldung. In Links anstelle der ID verwendet.

  • moments_tokenstring

    Teilnehmerbezogenes Momente-Token: erlaubt dieser Person die Nutzung der Veranstaltungs-Momente (digitales Gästebuch); Uploads über dieses Token werden der Person zugeordnet.

  • waitingboolean

    Die Anmeldung steht auf der Warteliste.

  • confirmedboolean

    Die Anmeldung ist bestätigt.

  • age_statusstring

    Altersstatus einer Kursanmeldung gegenüber den Altersgrenzen des Kurses (AgeLimits::STATUS_*), verwaltet von AgeCheckService; null = nicht geprüft (Termin- und Probeanmeldungen, Kurse ohne Grenzen, Funktion ausgeschaltet). Nur für die Verwaltung.

  • age_status_monthsinteger

    Monate über der näheren Altersgrenze bei der letzten Prüfung (positiv = älter, negativ = jünger)

  • age_status_changed_atstring (date-time)

    Zeitpunkt, zu dem sich der Altersstatus des Teilnehmers zuletzt geändert hat.

  • age_notified_atstring (date-time)

    Wann das Büro über den aktuellen Altersstatus informiert wurde (Übersicht)

  • externalboolean

    Die Anmeldung wurde von einer externen Stelle vorgenommen.

  • deletion_reasonstring

    Grund für die Stornierung der Anmeldung.

  • billedboolean

    Die Anmeldung wurde abgerechnet.

  • direct_billingboolean
  • direct_billing_check_datestring (date-time)
  • direct_billing_tokenstring
  • wait_list_confirmation_tokenstring
  • wait_list_confirmation_sent_atstring (date-time)
  • wait_list_confirmation_deadlinestring (date-time)
  • wait_list_confirmed_atstring (date-time)
  • wait_list_pending_confirmationboolean
  • wait_list_sort_orderinteger
  • birthdaystring (date-time)

    Geburtstag des Teilnehmers.

  • known_allergiesstring

    Bekannte Allergien des Teilnehmers.

  • confirmed_no_allergiesboolean

    Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

  • allow_photosboolean

    Erziehungsberechtigte(r) erlaubt Fotos des Teilnehmers.

  • allow_child_aloneboolean

    Teilnehmende Person darf nach der Veranstaltung allein gehen.

  • authorized_pickupstring

    Personen, die den Teilnehmer abholen dürfen.

  • needs_supportboolean

    Teilnehmende Person benötigt Unterstützung, zum Beispiel bei der Inklusion.

  • support_descriptionstring

    Beschreibung der Unterstützung, die der Teilnehmer benötigt.

  • financial_supportboolean

    Teilnehmende Person erhält eine finanzielle Förderung.

  • financial_support_numberstring

    Nummer der finanziellen Förderung, zum Beispiel eines Gutscheins.

  • municipal_supportboolean

    Teilnehmende Person erhält eine kommunale Förderung.

  • municipal_support_numberstring

    Nummer der kommunalen Förderung.

  • grade_levelinteger

    Schuljahrgang der teilnehmenden Person.

  • school_classstring

    Schulklasse der teilnehmenden Person.

  • confirmed_disclaimerboolean

    Teilnehmende Person hat den Haftungsausschluss bestätigt.

  • confirmed_privacyboolean

    Teilnehmende Person hat die Datenschutzerklärung bestätigt.

  • confirmed_cancellation_policyboolean

    Teilnehmende Person hat die Stornierungsbedingungen bestätigt.

  • free_note_onestring

    Freie Notiz 1, bei der Anmeldung eingetragen.

  • free_note_twostring

    Freie Notiz 2, bei der Anmeldung eingetragen.

  • free_note_threestring

    Freie Notiz 3, bei der Anmeldung eingetragen.

  • free_note_fourstring

    Freie Notiz 4, bei der Anmeldung eingetragen.

  • productPredefinedBillingItem13

    Produkt, mit dem die Anmeldung abgerechnet wird.

    Felder anzeigen (81)
    • idinteger

      Primärschlüssel der zugeordneten Abrechnungsposition. Interne ID.

    • namestringPflicht

      Name der Abrechnungsposition.

    • descriptionstringPflicht

      Beschreibung des Abrechnungspostens, die dem Kunden angezeigt wird.

    • internal_descriptionstring

      Interne Beschreibung der Abrechnungsposition, wird dem Kunden nicht angezeigt.

    • fixed_hoursnumber (float)

      Feste Anzahl abgerechneter Stunden.

    • fixed_pricenumber (float)

      Fester abgerechneter Preis.

    • fixed_price_base_unitnumber (float)

      Basiseinheit für den Festpreis.

    • price_fixed_hoursnumber (float)

      Preis für die Pauschalstunden.

    • price_additional_hoursnumber (float)

      Preis für jede weitere Stunde.

    • name_additional_hoursstring

      Name des Zusatzstunden-Postens.

    • description_additional_hoursstring

      Beschreibung des Zusatzstundenpostens.

    • time_billed_on_ticket_closeboolean

      Ob die Zeit beim Schließen des Tickets abgerechnet wird.

    • billing_typeBillingItemType

      Typ der Abrechnungsposition.

    • buying_pricenumber (float)

      Einkaufspreis der Position.

    • recurrenceCRMRecurrence

      Wiederholung, der die Abrechnungsposition folgt.

    • deletedboolean

      Ob die Abrechnungsposition gelöscht ist.

    • condition_date_afterstring (date-time)

      Der Posten gilt nur für Termine nach diesem Datum.

    • condition_date_beforestring (date-time)

      Der Posten gilt nur für Termine vor diesem Datum.

    • condition_country_codestring

      Ländercode, für den der Posten gilt.

    • condition_zip_code_fromstring

      Beginn des PLZ-Bereichs, für den die Position gilt.

    • condition_zip_code_tostring

      Ende des PLZ-Bereichs, auf den der Posten zutrifft.

    • condition_time_after_hourinteger

      Der Posten gilt nur ab dieser Tagesstunde.

    • condition_max_lengthinteger

      Maximale Länge, für die der Eintrag gilt.

    • condition_time_before_hourinteger

      Der Posten gilt nur bis zu dieser Tagesstunde.

    • condition_sub_access_tagAccessTag

      Zugriffs-Tag, das ein Abonnement haben muss, damit der Eintrag gilt.

    • condition_show_despite_missing_access_tagboolean

      Ob die Position auch dann angezeigt wird, wenn das Zugriffs-Tag fehlt.

    • condition_sub_free_logicstring

      Freie Bedingungslogik für das Abo.

    • fixed_price_logicstring

      Freie Logik, die den Festpreis berechnet.

    • sub_self_service_addboolean

      Ob Mitglieder das Abonnement selbst hinzufügen können.

    • sub_self_service_deleteboolean

      Ob Mitglieder das Abonnement selbst kündigen können.

    • sub_self_service_add_fixed_pricenumber (float)

      Fester Preis, der berechnet wird, wenn Mitglieder das Abo selbst hinzufügen.

    • sub_self_service_delete_fixed_pricenumber (float)

      Fester Preis, der berechnet wird, wenn Mitglieder das Abo selbst kündigen.

    • sub_pre_paidboolean

      Ob das Abonnement im Voraus bezahlt wird.

    • sub_only_billed_after_startboolean

      Ob das Abonnement erst nach seinem Beginn abgerechnet wird.

    • sub_people_age_group_oneinteger

      Obere Altersgrenze der Altersgruppe eins.

    • sub_people_age_group_one_discountinteger

      Rabatt in Prozent für Altersgruppe eins.

    • sub_people_age_group_one_freeinteger

      Anzahl der freien Plätze für Altersgruppe eins.

    • sub_people_age_group_twointeger

      Obere Altersgrenze der Altersgruppe zwei.

    • sub_people_age_group_two_discountinteger

      Rabatt in Prozent für Altersgruppe zwei.

    • sub_people_age_group_two_freeinteger

      Anzahl der freien Plätze für Altersgruppe zwei.

    • sub_people_age_group_threeinteger

      Obere Altersgrenze der Altersgruppe drei.

    • sub_people_age_group_three_discountinteger

      Rabatt in Prozent für Altersgruppe drei.

    • sub_people_age_group_three_freeinteger

      Anzahl der freien Plätze für Altersgruppe drei.

    • sub_people_age_group_fourinteger

      Obere Altersgrenze der Altersgruppe vier.

    • sub_people_age_group_four_discountinteger

      Rabatt in Prozent für Altersgruppe vier.

    • sub_people_age_group_four_freeinteger

      Anzahl der freien Plätze für Altersgruppe vier.

    • price_is_bruttoboolean

      Ob die Preise Bruttopreise inklusive Steuer sind.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • companyCRMCompany

      Unternehmen, zu dem der Abrechnungsposten gehört.

    • parentPredefinedBillingItem13

      Übergeordneter Abrechnungsposten, zum Beispiel für Varianten.

    • is_preferredboolean

      Der Posten ist bevorzugt und wird zuerst angezeigt.

    • is_defaultboolean

      Der Posten ist der Standard für seinen Typ.

    • is_discountboolean

      Der Posten ist ein Rabatt.

    • is_freeboolean

      Der Posten ist kostenfrei.

    • is_passiveboolean

      Der Posten ist passiv und kann nicht mehr ausgewählt werden.

    • is_globalboolean

      Der Posten ist für alle Unternehmen verfügbar.

    • inventory_countinteger

      Bestand an Stück, sofern der Gegenstand ein Produkt ist.

    • stock_itemboolean

      Dies ist ein Kennzeichen für Artikel, die jederzeit bestellt werden können

    • producer_guarantee_yearsnumber (float)

      Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels.

    • energy_label_attachmentAttachment10

      Energielabel (EU-Energieverbrauchskennzeichnung) als Bild/PDF für Shop, Warenkorb und E-Mail. EU-Energielabel als Bild/PDF dieses Produkts.

    • garan_label_attachmentAttachment10

      Grosses EU GARAN Label (DVO 2025/1960): kostenlose Haltbarkeitsgarantie des Herstellers von mehr als zwei Jahren, mit Jahren, Marke und Modell.

    • garan_label_pictogram_attachmentAttachment10

      „Nested label“ / Piktogramm des EU-GARAN-Labels: zeigt nur die Jahre, beim Klick/Hover muss das große Label (garanLabelAttachment) erscheinen. EU-GARAN-„nested label“-Piktogramm, das nur die Jahre zeigt; verlinkt auf das vollständige Label online.

    • public_categorystring

      Kategorie des öffentlich angezeigten Postens.

    • condition_booking_content_typeBookingContentType18

      Eintrag gilt nur für Buchungen mit diesem Inhaltstyp (z. B. Flugtyp). Null = alle Inhaltstypen.

    • usage_time_baseinteger

      Zeitpaar des Abschnitts für die Nutzungsabrechnung: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME oder BILLING_TYPE_FLIGHT_TIME. Null = billingType des Nutzungsdatensatzes übernehmen.

    • base_locationBaseLocation10

      Standort, zu dem diese Gebühr gehört (z. B. Flughafen-Lande-/Startgebühr), Kategorie CATEGORY_LOCATION

    • condition_day_of_week_maskinteger

      Wochentags-Bitmaske (Mo=1 ... So=64, siehe DayOfWeekBitmaskHelper). Null = jeden Tag.

    • condition_first_usage_onlyboolean

      Die Gebühr wird nur einmal je Nutzungssatz angewendet (erster passender Abschnitt, Menge 1)

    • budget_grant_countinteger

      Anzahl der Veranstaltungsanmeldungen, die dieses Produkt beim Kauf gewährt (null = kein Kontingent)

    • budget_create_onceboolean

      Wenn true, wird das Budget nur einmal pro Kombination aus Person und Produkt angelegt. Bei wiederkehrenden Abonnements: monatliche Zahlung, aber jährliches Budget.

    • ticket_quotainteger

      Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis). Null = nur das Teilnehmerlimit der Veranstaltung zählt.

    • ticket_sale_startstring (date-time)

      Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Frühbucher ab), null = sofort.

    • ticket_sale_endstring (date-time)

      Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Frühbucher bis), null = bis zum Anmeldeschluss.

    • ticket_seat_zonestring

      Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur für Plätze dieser Preiszone (BaseLocationPlanItem::seatZone), null = für jeden Platz.

    • cancellation_term_unitstring

      Zulässige Kündigungsfristen für dieses Abonnement-Produkt. Null / leer = Standard des Vereins aus den Einstellungen übernehmen. Siehe CancellationTermCalculator::TERM_UNITS.

    • cancellation_term_datesstring

      Kommagetrennte Liste fester Kündigungstermine im Format TT.MM, z. B. "31.03,30.06,30.09,31.12". Wird nur verwendet, wenn cancellationTermUnit CUSTOM ist.

    • cancellation_notice_valueinteger

      Numerischer Wert der Kündigungsfrist vor dem Kündigungstermin. Null = von den Einstellungen übernehmen.

    • cancellation_notice_unitstring

      Einheit der Frist: DAYS, WEEKS oder MONTHS. Null = aus den Einstellungen übernehmen.

    • … 6 weitere Felder
  • invoice_productsarray<BaseEventSignUpProductItem3>

    Produktpositionen, die der Rechnung der Anmeldung hinzugefügt werden.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel der Produktposition. Interne ID.

    • event_sign_upBaseEventSignUp7

      Anmeldung, zu der die Produktposition gehört.

    • productPredefinedBillingItem13

      Produkt, das abgerechnet wird.

    • quantitynumber (float)

      Menge des Produkts.

    • billedboolean

      Der Produktposten wurde abgerechnet.

  • generate_date_endstring (date-time)

    Enddatum der generierten Buchungen für die Anmeldung.

  • variantBaseEventVariant

    Event-Variante, zu der die Anmeldung gehört.

    Felder anzeigen (4)
    • idinteger

      Primärschlüssel der Veranstaltungsvariante. Interne ID.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

  • invitationBaseEventInvitation5

    Einladung, mit der die Anmeldung erfolgt ist.

    Felder anzeigen (9)
    • idinteger

      Primärschlüssel der Einladung. Interne ID.

    • readboolean

      Die Einladung wurde gelesen.

    • messagestring

      Mit der Einladung gesendete Nachricht.

    • reply_messagestring

      Antwortnachricht der eingeladenen Person.

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • orderinteger

      Position des Datensatzes in der Reihenfolge.

  • event_access_budgetEventAccessBudget4

    Für die Anmeldung verwendetes Zugriffsbudget.

    Felder anzeigen (19)
    • idinteger

      Primärschlüssel des Veranstaltungs-Zugangsbudgets. Interne ID.

    • personCRMPerson10

      Person, zu der das Budget gehört.

    • total_budgetinteger

      Gesamtzahl der gewährten Anmeldungen (z. B. 10 bei einer 10er-Karte)

    • used_budgetinteger

      Anzahl der bereits verbrauchten Anmeldungen

    • valid_fromstring (date-time)

      Beginn des Budgetzeitraums.

    • valid_untilstring (date-time)

      Ende des Budgetzeitraums.

    • base_eventBaseEvent25

      Scope: Budget auf eine bestimmte Veranstaltung beschränken

    • unified_categoryUnifiedCategory41

      Scope: Budget auf Veranstaltungen dieser einheitlichen Kategorie beschränken

    • event_typestring

      Scope: Budget auf Veranstaltungen dieses Veranstaltungstyps beschränken (WORKSHOP, CAMP, COURSE usw.)

    • source_typestring

      Wie dieses Budget angelegt wurde: 'purchase', 'bonus', 'manual'

    • trial_policyTrialPolicy6

      Regel eines Probe-Passes (sourceType trial)

    • trial_statusstring

      aktiv, aufgebraucht (alle Termine verbraucht und abgelaufen), umgewandelt (Kursplatz oder Mitgliedschaft), abgelaufen (Gültigkeit vorbei), storniert (vom Büro beendet)

    • trial_exhausted_atstring (date-time)

      Zeitpunkt, zu dem alle Schnupperplätze belegt waren.

    • trial_follow_up_sent_atstring (date-time)

      Zeitpunkt, zu dem die Nachfassaktion nach dem Schnuppern gesendet wurde.

    • trial_reminder_sent_atstring (date-time)

      Zeitpunkt, zu dem die Schnupper-Erinnerung versendet wurde.

    • trial_converted_atstring (date-time)

      Zeitpunkt, zu dem das Schnuppern in eine Mitgliedschaft umgewandelt wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • media_questionnaire_answerMediaQuestionnaireAnswer11

    Antwort auf den Fragebogen der Veranstaltung.

    Felder anzeigen (29)
    • idinteger

      Primärschlüssel der Fragebogen-Antwort. Interne ID.

    • genderstring

      Geschlecht des Teilnehmers.

    • confirmedboolean

      Die Antwort ist bestätigt.

    • draftboolean

      Die Antwort ist ein Entwurf und noch nicht eingereicht.

    • processingboolean

      Die Antwort wird verarbeitet.

    • externalboolean

      Die Antwort wurde von einer externen Stelle gegeben.

    • birthdaystring (date-time)

      Geburtstag des Teilnehmers.

    • known_allergiesstring

      Bekannte Allergien des Teilnehmers.

    • confirmed_no_allergiesboolean

      Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

    • grade_levelinteger

      Schuljahrgang der teilnehmenden Person.

    • school_classstring

      Schulklasse der teilnehmenden Person.

    • review_statusstring

      Zweite Schleife nach dem KI-Vergleich (MediaQuestionnaire::$clarificationEnabled), ohne diese null: CLARIFICATION_PENDING, solange der Vergleich bzw. die Erzeugung der Klärungspunkte läuft, CLARIFICATION_OPEN, solange Punkte offen sind, COMPLETED, sobald die Prüfung abgeschlossen ist und die Ergebnisvorlage angelegt werden darf.

    • nace_sectionstring

      NACE-Abschnittscode (Buchstabe A-U)

    • nace_codestring

      NACE-Code (numerisch, z. B. 01.11, 62.01)

    • role_in_companystring

      Rolle bzw. Position des Befragten im Unternehmen

    • start_in_companystring

      Wann der Befragte im Unternehmen zu arbeiten begonnen hat

    • company_namestring

      Wann der Befragte im Unternehmen zu arbeiten begonnen hat

    • answer_durationinteger

      Dauer in Sekunden, die die befragte Person zum Ausfüllen des Fragebogens benötigte

    • billedboolean

      Die Antwort wurde abgerechnet.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • … 17 weitere Felder
  • … 44 weitere Felder
Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/trial/base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "baseBooking": 1,
    "person": 1
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "support_description": "Text",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel"
}

Schnupper-Kontingente mit ihren Schnupperterminen. Filter: person, baseEvent, unifiedCategory, trialPolicy, trialStatus.

GET/api/event/trial_pass

Query-Parameter

personinteger
baseEventinteger
unifiedCategoryinteger
trialPolicyinteger
trialStatusstring
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liste von {pass, event, sign_ups}

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

Aktion auf einem Probedurchgang: convert (Kursplatz bzw. Mitgliedschaft anderweitig vereinbart), cancel (Probezeit beenden, keine weiteren Termine) oder reset (ein neuer Durchgang: Termine und Nachverfolgung beginnen von vorn).

POST/api/event/trial_pass/{identifier}/{passAction}

Pfad-Parameter

identifierPflichtstring
passActionPflichtstringErlaubt: convertcancelreset

Antworten

200{pass, event, sign_ups}

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

Kursplätze, die für Schnupperpersonen (Schnupper-Reservierungen) mit den Schnupperterminen ihres Passes reserviert sind, für die Teilnehmerliste eines Kurses und das Büro. Filter: status (Standard: offene - reserviert, ausstehend, gesichert; "all" für alle Zustände), baseEvent, person, pass.

GET/api/event/trial_hold

Query-Parameter

statusstring
baseEventinteger
personinteger
passinteger

Antworten

200Liste von {hold, person, sign_ups, dates: [{sign_up_id, booking_id, start_time, end_time, deleted, present, trial_session_number, trial_session_max}]}

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

Aktion auf einem gehaltenen Kursplatz: secure (kein Termin), convert (reguläre Anmeldung mit der normalen Bestätigungs-E-Mail), extend (data.days bzw. Abfrage-Tage, Vorgabe 7) oder release (der Platz ist wieder frei, die Warteliste rückt nach).

POST/api/event/trial_hold/{identifier}/{holdAction}

Pfad-Parameter

identifierPflichtstring
holdActionPflichtstringErlaubt: secureconvertextendrelease

Query-Parameter

daysinteger

Antworten

200{hold, person, sign_ups}

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