Zum Inhalt springen
Developer

VolunteerShift

Ehrenamt6 EndpunkteTimeTracking / VolunteerShift

Helfer-Schichten auflisten

GET/api/time/volunteer_shift

Query-Parameter

idinteger
deletedbooleanStandardwert: false
namestring
startstring
endstring
eventstring
createdstring
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

200Liefert eine Liste der VolunteerShift-Objekte.array<VolunteerShift>

Felder anzeigen (16)
  • effective_credited_minutesinteger

    Minuten, die einem anwesenden Helfer gutgeschrieben werden.

  • signed_up_countinteger

    Helfer, die angemeldet sind oder teilgenommen haben - stornierte Anmeldungen geben ihren Platz wieder frei.

  • open_slotsinteger

    Freie Plätze, null wenn die Schicht kein Limit hat.

  • idinteger

    Primärschlüssel der Ehrenamtsschicht. Interne ID.

  • namestring

    Name der Ehrenamtsschicht.

  • descriptionstring

    Beschreibung der Ehrenamtsschicht.

  • locationstring

    Ort, an dem die Ehrenamtsschicht stattfindet.

  • startstring (date-time)

    Beginn des ehrenamtlichen Dienstes.

  • endstring (date-time)

    Ende der Ehrenamtsschicht.

  • required_helpersinteger

    Benötigte Helfer. 0 = kein Limit.

  • credited_minutesinteger

    Minuten je anwesendem Helfer gutgeschrieben. null = die Länge der Schicht.

  • signup_untilstring (date-time)

    Die Anmeldung endet zu diesem Zeitpunkt. null = bis zum Beginn des Dienstes.

  • eventBaseEvent10

    Event, zu dem die Helferschicht gehört.

    Felder anzeigen (45)
    • ticketSeatingPlanIdinteger

      ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • idinteger

      Primärschlüssel der Veranstaltung. Interne ID.

    • public_subtitlestring

      Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.

    • event_typestring

      Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.

    • event_people_limitinteger

      maximale Anzahl Personen, die an der Veranstaltung teilnehmen können

    • event_people_min_limitinteger

      minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen

    • hide_event_people_limitboolean

      eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden

    • has_wait_listboolean

      Die Veranstaltung hat eine Warteliste, sobald sie voll ist.

    • wait_list_confirmation_requiredboolean

      Teilnehmende von der Warteliste müssen ihren Platz bestätigen.

    • trial_enabledboolean

      Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.

    • can_sign_up_for_main_eventboolean

      Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.

    • only_sign_up_for_main_eventboolean

      Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.

    • start_timestring (date-time)

      Beginn der Veranstaltung.

    • end_timestring (date-time)

      Ende der Veranstaltung.

    • require_addressboolean

      Teilnehmende müssen bei der Anmeldung eine Adresse angeben.

    • require_contactboolean

      Teilnehmende müssen bei der Anmeldung Kontaktdaten angeben.

    • require_billingboolean

      Teilnehmende müssen bei der Anmeldung Rechnungsdaten angeben.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Teilnehmende müssen bei der Anmeldung ihr Alter angeben.

    • require_grade_levelboolean

      Teilnehmende müssen bei der Anmeldung ihre Schulstufe angeben.

    • require_free_note_field_idsstring

      IDs der Freitext-Notizfelder, die Teilnehmer ausfüllen müssen.

    • generate_new_bookingsboolean

      Buchungen werden für den Veranstaltungsplan automatisch erzeugt.

    • generate_new_bookings_v2boolean

      Buchungen werden mit der zweiten Version des Plan-Generators erzeugt.

    • generate_ignore_sys_calendarboolean

      Erzeugte Buchungen ignorieren die Feiertage des Systemkalenders.

    • generate_hour_startstring (date-time)

      Startzeit des Tages für erzeugte Buchungen.

    • generate_hour_endstring (date-time)

      Endzeit des Tages für generierte Buchungen.

    • generate_day_of_weekinteger

      Wochentag für erzeugte Buchungen.

    • bitmask_days_of_weekinteger

      Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet

    • bitmask_hours_startinteger

      Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt

    • summarized_date_timesstring

      Zeichenkette mit den Wochentagen und Stunden, zu denen eine Veranstaltung beginnt

    • customer_detail_ctastring

      In der Kunden-App auf der Veranstaltungsdetailseite angezeigter Call-to-Action-Text.

    • customer_badgestring

      Badge-Text, der in der Kunden-App bei der Veranstaltung angezeigt wird.

    • 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_public_liveboolean

      Live-Zeitnahme-Ergebnisse sind öffentlich.

    • timing_gps_trackingboolean

      GPS-Tracking der Teilnehmer ist für die Zeitmessung aktiviert.

    • timing_self_check_inboolean

      Teilnehmende können sich für die Zeitmessung selbst einchecken.

    • ticket_sales_enabledboolean

      Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.

    • ticket_max_per_orderinteger

      Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.

    • ticket_personalizedboolean

      Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.

    • ticket_seatingboolean

      Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.

  • deletedboolean

    Die Ehrenamts-Schicht wird gelöscht.

  • createdstring (date-time)

    Zeitpunkt, zu dem die Ehrenamtsschicht angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem die Ehrenamtsschicht zuletzt geändert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "description": "Text",
    "effective_credited_minutes": 1,
    "signed_up_count": 1,
    "open_slots": 1,
    "location": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00",
    "required_helpers": 1
  }
]

Helferschicht hinzufügen

POST/api/time/volunteer_shift

Request-Body application/json

  • dataVolunteerShift2
    Felder anzeigen (10)
    • namestring

      Name der Ehrenamtsschicht.

    • descriptionstring

      Beschreibung der Ehrenamtsschicht.

    • locationstring

      Ort, an dem die Ehrenamtsschicht stattfindet.

    • startstring (date-time)

      Beginn des ehrenamtlichen Dienstes.

    • endstring (date-time)

      Ende der Ehrenamtsschicht.

    • required_helpersinteger

      Benötigte Helfer. 0 = kein Limit.

    • credited_minutesinteger

      Minuten je anwesendem Helfer gutgeschrieben. null = die Länge der Schicht.

    • signup_untilstring (date-time)

      Die Anmeldung endet zu diesem Zeitpunkt. null = bis zum Beginn des Dienstes.

    • eventBaseEvent12

      Event, zu dem die Helferschicht gehört.

    • deletedboolean

      Die Ehrenamts-Schicht wird gelöscht.

Antworten

200VolunteerShift neu anlegenVolunteerShift

Felder anzeigen (16)
  • effective_credited_minutesinteger

    Minuten, die einem anwesenden Helfer gutgeschrieben werden.

  • signed_up_countinteger

    Helfer, die angemeldet sind oder teilgenommen haben - stornierte Anmeldungen geben ihren Platz wieder frei.

  • open_slotsinteger

    Freie Plätze, null wenn die Schicht kein Limit hat.

  • idinteger

    Primärschlüssel der Ehrenamtsschicht. Interne ID.

  • namestring

    Name der Ehrenamtsschicht.

  • descriptionstring

    Beschreibung der Ehrenamtsschicht.

  • locationstring

    Ort, an dem die Ehrenamtsschicht stattfindet.

  • startstring (date-time)

    Beginn des ehrenamtlichen Dienstes.

  • endstring (date-time)

    Ende der Ehrenamtsschicht.

  • required_helpersinteger

    Benötigte Helfer. 0 = kein Limit.

  • credited_minutesinteger

    Minuten je anwesendem Helfer gutgeschrieben. null = die Länge der Schicht.

  • signup_untilstring (date-time)

    Die Anmeldung endet zu diesem Zeitpunkt. null = bis zum Beginn des Dienstes.

  • eventBaseEvent10

    Event, zu dem die Helferschicht gehört.

    Felder anzeigen (45)
    • ticketSeatingPlanIdinteger

      ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • idinteger

      Primärschlüssel der Veranstaltung. Interne ID.

    • public_subtitlestring

      Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.

    • event_typestring

      Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.

    • event_people_limitinteger

      maximale Anzahl Personen, die an der Veranstaltung teilnehmen können

    • event_people_min_limitinteger

      minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen

    • hide_event_people_limitboolean

      eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden

    • has_wait_listboolean

      Die Veranstaltung hat eine Warteliste, sobald sie voll ist.

    • wait_list_confirmation_requiredboolean

      Teilnehmende von der Warteliste müssen ihren Platz bestätigen.

    • trial_enabledboolean

      Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.

    • can_sign_up_for_main_eventboolean

      Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.

    • only_sign_up_for_main_eventboolean

      Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.

    • start_timestring (date-time)

      Beginn der Veranstaltung.

    • end_timestring (date-time)

      Ende der Veranstaltung.

    • require_addressboolean

      Teilnehmende müssen bei der Anmeldung eine Adresse angeben.

    • require_contactboolean

      Teilnehmende müssen bei der Anmeldung Kontaktdaten angeben.

    • require_billingboolean

      Teilnehmende müssen bei der Anmeldung Rechnungsdaten angeben.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Teilnehmende müssen bei der Anmeldung ihr Alter angeben.

    • require_grade_levelboolean

      Teilnehmende müssen bei der Anmeldung ihre Schulstufe angeben.

    • require_free_note_field_idsstring

      IDs der Freitext-Notizfelder, die Teilnehmer ausfüllen müssen.

    • generate_new_bookingsboolean

      Buchungen werden für den Veranstaltungsplan automatisch erzeugt.

    • generate_new_bookings_v2boolean

      Buchungen werden mit der zweiten Version des Plan-Generators erzeugt.

    • generate_ignore_sys_calendarboolean

      Erzeugte Buchungen ignorieren die Feiertage des Systemkalenders.

    • generate_hour_startstring (date-time)

      Startzeit des Tages für erzeugte Buchungen.

    • generate_hour_endstring (date-time)

      Endzeit des Tages für generierte Buchungen.

    • generate_day_of_weekinteger

      Wochentag für erzeugte Buchungen.

    • bitmask_days_of_weekinteger

      Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet

    • bitmask_hours_startinteger

      Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt

    • summarized_date_timesstring

      Zeichenkette mit den Wochentagen und Stunden, zu denen eine Veranstaltung beginnt

    • customer_detail_ctastring

      In der Kunden-App auf der Veranstaltungsdetailseite angezeigter Call-to-Action-Text.

    • customer_badgestring

      Badge-Text, der in der Kunden-App bei der Veranstaltung angezeigt wird.

    • 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_public_liveboolean

      Live-Zeitnahme-Ergebnisse sind öffentlich.

    • timing_gps_trackingboolean

      GPS-Tracking der Teilnehmer ist für die Zeitmessung aktiviert.

    • timing_self_check_inboolean

      Teilnehmende können sich für die Zeitmessung selbst einchecken.

    • ticket_sales_enabledboolean

      Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.

    • ticket_max_per_orderinteger

      Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.

    • ticket_personalizedboolean

      Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.

    • ticket_seatingboolean

      Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.

  • deletedboolean

    Die Ehrenamts-Schicht wird gelöscht.

  • createdstring (date-time)

    Zeitpunkt, zu dem die Ehrenamtsschicht angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem die Ehrenamtsschicht zuletzt geändert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "description": "Text",
    "location": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00",
    "required_helpers": 1
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "effective_credited_minutes": 1,
  "signed_up_count": 1,
  "open_slots": 1,
  "location": "string",
  "start": "2026-10-15T09:30:00+02:00",
  "end": "2026-10-15T09:30:00+02:00",
  "required_helpers": 1
}

Einzelne Helferschicht abrufen

GET/api/time/volunteer_shift/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert ein einzelnes VolunteerShift-Objekt.VolunteerShift

Felder anzeigen (16)
  • effective_credited_minutesinteger

    Minuten, die einem anwesenden Helfer gutgeschrieben werden.

  • signed_up_countinteger

    Helfer, die angemeldet sind oder teilgenommen haben - stornierte Anmeldungen geben ihren Platz wieder frei.

  • open_slotsinteger

    Freie Plätze, null wenn die Schicht kein Limit hat.

  • idinteger

    Primärschlüssel der Ehrenamtsschicht. Interne ID.

  • namestring

    Name der Ehrenamtsschicht.

  • descriptionstring

    Beschreibung der Ehrenamtsschicht.

  • locationstring

    Ort, an dem die Ehrenamtsschicht stattfindet.

  • startstring (date-time)

    Beginn des ehrenamtlichen Dienstes.

  • endstring (date-time)

    Ende der Ehrenamtsschicht.

  • required_helpersinteger

    Benötigte Helfer. 0 = kein Limit.

  • credited_minutesinteger

    Minuten je anwesendem Helfer gutgeschrieben. null = die Länge der Schicht.

  • signup_untilstring (date-time)

    Die Anmeldung endet zu diesem Zeitpunkt. null = bis zum Beginn des Dienstes.

  • eventBaseEvent10

    Event, zu dem die Helferschicht gehört.

    Felder anzeigen (45)
    • ticketSeatingPlanIdinteger

      ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • idinteger

      Primärschlüssel der Veranstaltung. Interne ID.

    • public_subtitlestring

      Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.

    • event_typestring

      Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.

    • event_people_limitinteger

      maximale Anzahl Personen, die an der Veranstaltung teilnehmen können

    • event_people_min_limitinteger

      minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen

    • hide_event_people_limitboolean

      eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden

    • has_wait_listboolean

      Die Veranstaltung hat eine Warteliste, sobald sie voll ist.

    • wait_list_confirmation_requiredboolean

      Teilnehmende von der Warteliste müssen ihren Platz bestätigen.

    • trial_enabledboolean

      Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.

    • can_sign_up_for_main_eventboolean

      Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.

    • only_sign_up_for_main_eventboolean

      Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.

    • start_timestring (date-time)

      Beginn der Veranstaltung.

    • end_timestring (date-time)

      Ende der Veranstaltung.

    • require_addressboolean

      Teilnehmende müssen bei der Anmeldung eine Adresse angeben.

    • require_contactboolean

      Teilnehmende müssen bei der Anmeldung Kontaktdaten angeben.

    • require_billingboolean

      Teilnehmende müssen bei der Anmeldung Rechnungsdaten angeben.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Teilnehmende müssen bei der Anmeldung ihr Alter angeben.

    • require_grade_levelboolean

      Teilnehmende müssen bei der Anmeldung ihre Schulstufe angeben.

    • require_free_note_field_idsstring

      IDs der Freitext-Notizfelder, die Teilnehmer ausfüllen müssen.

    • generate_new_bookingsboolean

      Buchungen werden für den Veranstaltungsplan automatisch erzeugt.

    • generate_new_bookings_v2boolean

      Buchungen werden mit der zweiten Version des Plan-Generators erzeugt.

    • generate_ignore_sys_calendarboolean

      Erzeugte Buchungen ignorieren die Feiertage des Systemkalenders.

    • generate_hour_startstring (date-time)

      Startzeit des Tages für erzeugte Buchungen.

    • generate_hour_endstring (date-time)

      Endzeit des Tages für generierte Buchungen.

    • generate_day_of_weekinteger

      Wochentag für erzeugte Buchungen.

    • bitmask_days_of_weekinteger

      Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet

    • bitmask_hours_startinteger

      Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt

    • summarized_date_timesstring

      Zeichenkette mit den Wochentagen und Stunden, zu denen eine Veranstaltung beginnt

    • customer_detail_ctastring

      In der Kunden-App auf der Veranstaltungsdetailseite angezeigter Call-to-Action-Text.

    • customer_badgestring

      Badge-Text, der in der Kunden-App bei der Veranstaltung angezeigt wird.

    • 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_public_liveboolean

      Live-Zeitnahme-Ergebnisse sind öffentlich.

    • timing_gps_trackingboolean

      GPS-Tracking der Teilnehmer ist für die Zeitmessung aktiviert.

    • timing_self_check_inboolean

      Teilnehmende können sich für die Zeitmessung selbst einchecken.

    • ticket_sales_enabledboolean

      Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.

    • ticket_max_per_orderinteger

      Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.

    • ticket_personalizedboolean

      Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.

    • ticket_seatingboolean

      Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.

  • deletedboolean

    Die Ehrenamts-Schicht wird gelöscht.

  • createdstring (date-time)

    Zeitpunkt, zu dem die Ehrenamtsschicht angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem die Ehrenamtsschicht zuletzt geändert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "effective_credited_minutes": 1,
  "signed_up_count": 1,
  "open_slots": 1,
  "location": "string",
  "start": "2026-10-15T09:30:00+02:00",
  "end": "2026-10-15T09:30:00+02:00",
  "required_helpers": 1
}

Helferschicht aktualisieren

PUT/api/time/volunteer_shift/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataVolunteerShift2
    Felder anzeigen (10)
    • namestring

      Name der Ehrenamtsschicht.

    • descriptionstring

      Beschreibung der Ehrenamtsschicht.

    • locationstring

      Ort, an dem die Ehrenamtsschicht stattfindet.

    • startstring (date-time)

      Beginn des ehrenamtlichen Dienstes.

    • endstring (date-time)

      Ende der Ehrenamtsschicht.

    • required_helpersinteger

      Benötigte Helfer. 0 = kein Limit.

    • credited_minutesinteger

      Minuten je anwesendem Helfer gutgeschrieben. null = die Länge der Schicht.

    • signup_untilstring (date-time)

      Die Anmeldung endet zu diesem Zeitpunkt. null = bis zum Beginn des Dienstes.

    • eventBaseEvent12

      Event, zu dem die Helferschicht gehört.

    • deletedboolean

      Die Ehrenamts-Schicht wird gelöscht.

Antworten

200VolunteerShift aktualisierenVolunteerShift

Felder anzeigen (16)
  • effective_credited_minutesinteger

    Minuten, die einem anwesenden Helfer gutgeschrieben werden.

  • signed_up_countinteger

    Helfer, die angemeldet sind oder teilgenommen haben - stornierte Anmeldungen geben ihren Platz wieder frei.

  • open_slotsinteger

    Freie Plätze, null wenn die Schicht kein Limit hat.

  • idinteger

    Primärschlüssel der Ehrenamtsschicht. Interne ID.

  • namestring

    Name der Ehrenamtsschicht.

  • descriptionstring

    Beschreibung der Ehrenamtsschicht.

  • locationstring

    Ort, an dem die Ehrenamtsschicht stattfindet.

  • startstring (date-time)

    Beginn des ehrenamtlichen Dienstes.

  • endstring (date-time)

    Ende der Ehrenamtsschicht.

  • required_helpersinteger

    Benötigte Helfer. 0 = kein Limit.

  • credited_minutesinteger

    Minuten je anwesendem Helfer gutgeschrieben. null = die Länge der Schicht.

  • signup_untilstring (date-time)

    Die Anmeldung endet zu diesem Zeitpunkt. null = bis zum Beginn des Dienstes.

  • eventBaseEvent10

    Event, zu dem die Helferschicht gehört.

    Felder anzeigen (45)
    • ticketSeatingPlanIdinteger

      ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • idinteger

      Primärschlüssel der Veranstaltung. Interne ID.

    • public_subtitlestring

      Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.

    • event_typestring

      Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.

    • event_people_limitinteger

      maximale Anzahl Personen, die an der Veranstaltung teilnehmen können

    • event_people_min_limitinteger

      minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen

    • hide_event_people_limitboolean

      eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden

    • has_wait_listboolean

      Die Veranstaltung hat eine Warteliste, sobald sie voll ist.

    • wait_list_confirmation_requiredboolean

      Teilnehmende von der Warteliste müssen ihren Platz bestätigen.

    • trial_enabledboolean

      Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.

    • can_sign_up_for_main_eventboolean

      Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.

    • only_sign_up_for_main_eventboolean

      Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.

    • start_timestring (date-time)

      Beginn der Veranstaltung.

    • end_timestring (date-time)

      Ende der Veranstaltung.

    • require_addressboolean

      Teilnehmende müssen bei der Anmeldung eine Adresse angeben.

    • require_contactboolean

      Teilnehmende müssen bei der Anmeldung Kontaktdaten angeben.

    • require_billingboolean

      Teilnehmende müssen bei der Anmeldung Rechnungsdaten angeben.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Teilnehmende müssen bei der Anmeldung ihr Alter angeben.

    • require_grade_levelboolean

      Teilnehmende müssen bei der Anmeldung ihre Schulstufe angeben.

    • require_free_note_field_idsstring

      IDs der Freitext-Notizfelder, die Teilnehmer ausfüllen müssen.

    • generate_new_bookingsboolean

      Buchungen werden für den Veranstaltungsplan automatisch erzeugt.

    • generate_new_bookings_v2boolean

      Buchungen werden mit der zweiten Version des Plan-Generators erzeugt.

    • generate_ignore_sys_calendarboolean

      Erzeugte Buchungen ignorieren die Feiertage des Systemkalenders.

    • generate_hour_startstring (date-time)

      Startzeit des Tages für erzeugte Buchungen.

    • generate_hour_endstring (date-time)

      Endzeit des Tages für generierte Buchungen.

    • generate_day_of_weekinteger

      Wochentag für erzeugte Buchungen.

    • bitmask_days_of_weekinteger

      Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet

    • bitmask_hours_startinteger

      Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt

    • summarized_date_timesstring

      Zeichenkette mit den Wochentagen und Stunden, zu denen eine Veranstaltung beginnt

    • customer_detail_ctastring

      In der Kunden-App auf der Veranstaltungsdetailseite angezeigter Call-to-Action-Text.

    • customer_badgestring

      Badge-Text, der in der Kunden-App bei der Veranstaltung angezeigt wird.

    • 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_public_liveboolean

      Live-Zeitnahme-Ergebnisse sind öffentlich.

    • timing_gps_trackingboolean

      GPS-Tracking der Teilnehmer ist für die Zeitmessung aktiviert.

    • timing_self_check_inboolean

      Teilnehmende können sich für die Zeitmessung selbst einchecken.

    • ticket_sales_enabledboolean

      Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.

    • ticket_max_per_orderinteger

      Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.

    • ticket_personalizedboolean

      Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.

    • ticket_seatingboolean

      Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.

  • deletedboolean

    Die Ehrenamts-Schicht wird gelöscht.

  • createdstring (date-time)

    Zeitpunkt, zu dem die Ehrenamtsschicht angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem die Ehrenamtsschicht zuletzt geändert wurde.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "description": "Text",
    "location": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00",
    "required_helpers": 1
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "effective_credited_minutes": 1,
  "signed_up_count": 1,
  "open_slots": 1,
  "location": "string",
  "start": "2026-10-15T09:30:00+02:00",
  "end": "2026-10-15T09:30:00+02:00",
  "required_helpers": 1
}

Helferschicht aktualisieren

PATCH/api/time/volunteer_shift/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataVolunteerShift2
    Felder anzeigen (10)
    • namestring

      Name der Ehrenamtsschicht.

    • descriptionstring

      Beschreibung der Ehrenamtsschicht.

    • locationstring

      Ort, an dem die Ehrenamtsschicht stattfindet.

    • startstring (date-time)

      Beginn des ehrenamtlichen Dienstes.

    • endstring (date-time)

      Ende der Ehrenamtsschicht.

    • required_helpersinteger

      Benötigte Helfer. 0 = kein Limit.

    • credited_minutesinteger

      Minuten je anwesendem Helfer gutgeschrieben. null = die Länge der Schicht.

    • signup_untilstring (date-time)

      Die Anmeldung endet zu diesem Zeitpunkt. null = bis zum Beginn des Dienstes.

    • eventBaseEvent12

      Event, zu dem die Helferschicht gehört.

    • deletedboolean

      Die Ehrenamts-Schicht wird gelöscht.

Antworten

200VolunteerShift aktualisierenVolunteerShift

Felder anzeigen (16)
  • effective_credited_minutesinteger

    Minuten, die einem anwesenden Helfer gutgeschrieben werden.

  • signed_up_countinteger

    Helfer, die angemeldet sind oder teilgenommen haben - stornierte Anmeldungen geben ihren Platz wieder frei.

  • open_slotsinteger

    Freie Plätze, null wenn die Schicht kein Limit hat.

  • idinteger

    Primärschlüssel der Ehrenamtsschicht. Interne ID.

  • namestring

    Name der Ehrenamtsschicht.

  • descriptionstring

    Beschreibung der Ehrenamtsschicht.

  • locationstring

    Ort, an dem die Ehrenamtsschicht stattfindet.

  • startstring (date-time)

    Beginn des ehrenamtlichen Dienstes.

  • endstring (date-time)

    Ende der Ehrenamtsschicht.

  • required_helpersinteger

    Benötigte Helfer. 0 = kein Limit.

  • credited_minutesinteger

    Minuten je anwesendem Helfer gutgeschrieben. null = die Länge der Schicht.

  • signup_untilstring (date-time)

    Die Anmeldung endet zu diesem Zeitpunkt. null = bis zum Beginn des Dienstes.

  • eventBaseEvent10

    Event, zu dem die Helferschicht gehört.

    Felder anzeigen (45)
    • ticketSeatingPlanIdinteger

      ID des Sitzplans, auch für die öffentliche Serialisierung und die Kunden-Serialisierung.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • idinteger

      Primärschlüssel der Veranstaltung. Interne ID.

    • public_subtitlestring

      Untertitel, der in der öffentlichen Veranstaltungsliste angezeigt wird.

    • event_typestring

      Art des Events, zum Beispiel Kurs, Fahrt oder Turnier.

    • event_people_limitinteger

      maximale Anzahl Personen, die an der Veranstaltung teilnehmen können

    • event_people_min_limitinteger

      minimale Anzahl Personen, die an der Veranstaltung teilnehmen müssen

    • hide_event_people_limitboolean

      eine Einstellung, um die Teilnehmerbegrenzung der Veranstaltung in der Frontend-Oberfläche auszublenden

    • has_wait_listboolean

      Die Veranstaltung hat eine Warteliste, sobald sie voll ist.

    • wait_list_confirmation_requiredboolean

      Teilnehmende von der Warteliste müssen ihren Platz bestätigen.

    • trial_enabledboolean

      Schnuppertermine (Schnuppern) werden für dieses Event angeboten. Standardmäßig deaktiviert: Das Event muss sich dafür aktiv entscheiden, die Regel stammt aus trialPolicy, der Kategorie des Events oder der Standardregel.

    • can_sign_up_for_main_eventboolean

      Teilnehmende dürfen sich für die Hauptveranstaltung anmelden.

    • only_sign_up_for_main_eventboolean

      Teilnehmende dürfen sich nur für die Hauptveranstaltung anmelden, nicht für Unterveranstaltungen.

    • start_timestring (date-time)

      Beginn der Veranstaltung.

    • end_timestring (date-time)

      Ende der Veranstaltung.

    • require_addressboolean

      Teilnehmende müssen bei der Anmeldung eine Adresse angeben.

    • require_contactboolean

      Teilnehmende müssen bei der Anmeldung Kontaktdaten angeben.

    • require_billingboolean

      Teilnehmende müssen bei der Anmeldung Rechnungsdaten angeben.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Teilnehmende müssen bei der Anmeldung ihr Alter angeben.

    • require_grade_levelboolean

      Teilnehmende müssen bei der Anmeldung ihre Schulstufe angeben.

    • require_free_note_field_idsstring

      IDs der Freitext-Notizfelder, die Teilnehmer ausfüllen müssen.

    • generate_new_bookingsboolean

      Buchungen werden für den Veranstaltungsplan automatisch erzeugt.

    • generate_new_bookings_v2boolean

      Buchungen werden mit der zweiten Version des Plan-Generators erzeugt.

    • generate_ignore_sys_calendarboolean

      Erzeugte Buchungen ignorieren die Feiertage des Systemkalenders.

    • generate_hour_startstring (date-time)

      Startzeit des Tages für erzeugte Buchungen.

    • generate_hour_endstring (date-time)

      Endzeit des Tages für generierte Buchungen.

    • generate_day_of_weekinteger

      Wochentag für erzeugte Buchungen.

    • bitmask_days_of_weekinteger

      Bitmask-Wert der Wochentage, an denen die Veranstaltung stattfindet

    • bitmask_hours_startinteger

      Bitmask-Wert der Stunden, zu denen eine Veranstaltung beginnt

    • summarized_date_timesstring

      Zeichenkette mit den Wochentagen und Stunden, zu denen eine Veranstaltung beginnt

    • customer_detail_ctastring

      In der Kunden-App auf der Veranstaltungsdetailseite angezeigter Call-to-Action-Text.

    • customer_badgestring

      Badge-Text, der in der Kunden-App bei der Veranstaltung angezeigt wird.

    • 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_public_liveboolean

      Live-Zeitnahme-Ergebnisse sind öffentlich.

    • timing_gps_trackingboolean

      GPS-Tracking der Teilnehmer ist für die Zeitmessung aktiviert.

    • timing_self_check_inboolean

      Teilnehmende können sich für die Zeitmessung selbst einchecken.

    • ticket_sales_enabledboolean

      Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.

    • ticket_max_per_orderinteger

      Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.

    • ticket_personalizedboolean

      Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.

    • ticket_seatingboolean

      Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.

  • deletedboolean

    Die Ehrenamts-Schicht wird gelöscht.

  • createdstring (date-time)

    Zeitpunkt, zu dem die Ehrenamtsschicht angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem die Ehrenamtsschicht zuletzt geändert wurde.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "description": "Text",
    "location": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00",
    "required_helpers": 1
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "description": "Text",
  "effective_credited_minutes": 1,
  "signed_up_count": 1,
  "open_slots": 1,
  "location": "string",
  "start": "2026-10-15T09:30:00+02:00",
  "end": "2026-10-15T09:30:00+02:00",
  "required_helpers": 1
}

Helferschicht archivieren. Gutschriften der teilnehmenden Helfer bleiben erhalten.

DELETE/api/time/volunteer_shift/{id}

Pfad-Parameter

idPflichtstring

Antworten

default

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift/42 \
  --header 'x-iw-jwt-token: <TOKEN>'