Zum Inhalt springen
Developer

EventSignUpScanner

Veranstaltungen4 EndpunkteEvent / EventSignUpScanner

Liste der nächsten Event-Anmeldungen einer Person abrufen

GET/api/event/scanner/base_event_signup/next/{personIdentifier}

Pfad-Parameter

personIdentifierPflichtstring

Query-Parameter

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 der nächsten Event-Anmeldungen einer Person abrufenarray<BaseEventSignUp>

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 GET \
  --url https://eure-instanz.iw-erp.de/api/event/scanner/base_event_signup/next/42 \
  --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
  }
]

Liste der nächsten Event-Anmeldungen einer Person abrufen

GET/api/event/scanner/base_event_signup/next

Query-Parameter

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 der nächsten Event-Anmeldungen einer Person abrufenarray<BaseEventSignUp>

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 GET \
  --url https://eure-instanz.iw-erp.de/api/event/scanner/base_event_signup/next \
  --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
  }
]

Aktionen für eine Event-Anmeldung einer Person auslösen

POST/api/event/scanner/base_event_signup/action/{personIdentifier}

Pfad-Parameter

personIdentifierPflichtstring

Query-Parameter

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

Request-Body application/json

  • dataSimpleChange
    Felder anzeigen (5)
    • idmixed

      Die ID der zu ändernden Entität, kann eine Zeichenkette oder eine ganze Zahl sein

    • actionstring

      Die auszuführende Aktion für die Entität

    • propertystring

      Die zu ändernde Eigenschaft der Entität

    • new_valuemixed

      Der neue Wert, der für die Eigenschaft gesetzt werden soll

    • doneboolean

      Gibt an, ob die Änderung verarbeitet wurde

Antworten

200Aktionen für eine Event-Anmeldung einer Person auslösenBaseEventSignUp

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/scanner/base_event_signup/action/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "action": "string",
    "property": "string",
    "new_value": null,
    "done": true
  }
}
'
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
}

Aktionen für eine Event-Anmeldung einer Person auslösen

POST/api/event/scanner/base_event_signup/action

Query-Parameter

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

Request-Body application/json

  • dataSimpleChange
    Felder anzeigen (5)
    • idmixed

      Die ID der zu ändernden Entität, kann eine Zeichenkette oder eine ganze Zahl sein

    • actionstring

      Die auszuführende Aktion für die Entität

    • propertystring

      Die zu ändernde Eigenschaft der Entität

    • new_valuemixed

      Der neue Wert, der für die Eigenschaft gesetzt werden soll

    • doneboolean

      Gibt an, ob die Änderung verarbeitet wurde

Antworten

200Aktionen für eine Event-Anmeldung einer Person auslösenBaseEventSignUp

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/scanner/base_event_signup/action \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "action": "string",
    "property": "string",
    "new_value": null,
    "done": true
  }
}
'
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
}