Zum Inhalt springen
Developer

VolunteerShiftAssignment

Ehrenamt6 EndpunkteTimeTracking / VolunteerShiftAssignment

Die Helfer der Schichten auflisten (Filter `shift`, `person`, `status`)

GET/api/time/volunteer_shift_assignment

Query-Parameter

idinteger
shiftstring
personstring
statusstring
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 VolunteerShiftAssignment-Objekte.array<VolunteerShiftAssignment>

Felder anzeigen (8)
  • hour_entry_idinteger
  • idinteger

    Primärschlüssel der Ehrenamtsschicht-Zuordnung. Interne ID.

  • shiftVolunteerShift3

    Ehrenamtsschicht, zu der die Zuweisung gehört.

    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.

    • eventBaseEvent25

      Event, zu dem die Helferschicht gehört.

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

  • personCRMPerson27

    Person, die der Schicht zugewiesen ist.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

  • statusstring

    Status der Zuweisung, zum Beispiel zugewiesen oder storniert.

  • notestring

    Anmerkung zur Zuweisung.

  • cancelled_atstring (date-time)

    Zeitpunkt, zu dem die Zuordnung storniert wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem die Zuordnung angelegt wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift_assignment \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "hour_entry_id": 42,
    "shift": {
      "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
    },
    "person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "number": 1,
      "manual_number": 1,
      "number_string": "string",
      "gender": "string",
      "nickname": "string",
      "preferred_color_hex": "string"
    },
    "status": "string",
    "note": "string",
    "cancelled_at": "2026-10-15T09:30:00+02:00",
    "created": "2026-10-15T09:30:00+02:00"
  }
]

Helfer zu einer Schicht hinzufügen. Die Verwaltung darf eine Schicht über ihr Limit hinaus besetzen.

POST/api/time/volunteer_shift_assignment

Request-Body application/json

  • dataVolunteerShiftAssignment2
    Felder anzeigen (4)
    • shiftVolunteerShift4

      Ehrenamtsschicht, zu der die Zuweisung gehört.

    • personCRMPerson34

      Person, die der Schicht zugewiesen ist.

    • statusstring

      Status der Zuweisung, zum Beispiel zugewiesen oder storniert.

    • notestring

      Anmerkung zur Zuweisung.

Antworten

200VolunteerShiftAssignment neu anlegenVolunteerShiftAssignment

Felder anzeigen (8)
  • hour_entry_idinteger
  • idinteger

    Primärschlüssel der Ehrenamtsschicht-Zuordnung. Interne ID.

  • shiftVolunteerShift3

    Ehrenamtsschicht, zu der die Zuweisung gehört.

    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.

    • eventBaseEvent25

      Event, zu dem die Helferschicht gehört.

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

  • personCRMPerson27

    Person, die der Schicht zugewiesen ist.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

  • statusstring

    Status der Zuweisung, zum Beispiel zugewiesen oder storniert.

  • notestring

    Anmerkung zur Zuweisung.

  • cancelled_atstring (date-time)

    Zeitpunkt, zu dem die Zuordnung storniert wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem die Zuordnung angelegt wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift_assignment \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "status": "string",
    "note": "string"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "hour_entry_id": 42,
  "shift": {
    "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
  },
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "number": 1,
    "manual_number": 1,
    "number_string": "string",
    "gender": "string",
    "nickname": "string",
    "preferred_color_hex": "string"
  },
  "status": "string",
  "note": "string",
  "cancelled_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00"
}

Einzelne Helferzuweisung abrufen

GET/api/time/volunteer_shift_assignment/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert ein einzelnes VolunteerShiftAssignment-Objekt.VolunteerShiftAssignment

Felder anzeigen (8)
  • hour_entry_idinteger
  • idinteger

    Primärschlüssel der Ehrenamtsschicht-Zuordnung. Interne ID.

  • shiftVolunteerShift3

    Ehrenamtsschicht, zu der die Zuweisung gehört.

    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.

    • eventBaseEvent25

      Event, zu dem die Helferschicht gehört.

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

  • personCRMPerson27

    Person, die der Schicht zugewiesen ist.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

  • statusstring

    Status der Zuweisung, zum Beispiel zugewiesen oder storniert.

  • notestring

    Anmerkung zur Zuweisung.

  • cancelled_atstring (date-time)

    Zeitpunkt, zu dem die Zuordnung storniert wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem die Zuordnung angelegt wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift_assignment/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "hour_entry_id": 42,
  "shift": {
    "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
  },
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "number": 1,
    "manual_number": 1,
    "number_string": "string",
    "gender": "string",
    "nickname": "string",
    "preferred_color_hex": "string"
  },
  "status": "string",
  "note": "string",
  "cancelled_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00"
}

Status eines Helfenden ändern: `attended` schreibt die Schicht gut, `no_show` / `cancelled` nehmen diese Gutschrift wieder zurück

PUT/api/time/volunteer_shift_assignment/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataVolunteerShiftAssignment2
    Felder anzeigen (4)
    • shiftVolunteerShift4

      Ehrenamtsschicht, zu der die Zuweisung gehört.

    • personCRMPerson34

      Person, die der Schicht zugewiesen ist.

    • statusstring

      Status der Zuweisung, zum Beispiel zugewiesen oder storniert.

    • notestring

      Anmerkung zur Zuweisung.

Antworten

200VolunteerShiftAssignment aktualisierenVolunteerShiftAssignment

Felder anzeigen (8)
  • hour_entry_idinteger
  • idinteger

    Primärschlüssel der Ehrenamtsschicht-Zuordnung. Interne ID.

  • shiftVolunteerShift3

    Ehrenamtsschicht, zu der die Zuweisung gehört.

    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.

    • eventBaseEvent25

      Event, zu dem die Helferschicht gehört.

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

  • personCRMPerson27

    Person, die der Schicht zugewiesen ist.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

  • statusstring

    Status der Zuweisung, zum Beispiel zugewiesen oder storniert.

  • notestring

    Anmerkung zur Zuweisung.

  • cancelled_atstring (date-time)

    Zeitpunkt, zu dem die Zuordnung storniert wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem die Zuordnung angelegt wurde.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift_assignment/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "status": "string",
    "note": "string"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "hour_entry_id": 42,
  "shift": {
    "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
  },
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "number": 1,
    "manual_number": 1,
    "number_string": "string",
    "gender": "string",
    "nickname": "string",
    "preferred_color_hex": "string"
  },
  "status": "string",
  "note": "string",
  "cancelled_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00"
}

Status eines Helfenden ändern: `attended` schreibt die Schicht gut, `no_show` / `cancelled` nehmen diese Gutschrift wieder zurück

PATCH/api/time/volunteer_shift_assignment/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataVolunteerShiftAssignment2
    Felder anzeigen (4)
    • shiftVolunteerShift4

      Ehrenamtsschicht, zu der die Zuweisung gehört.

    • personCRMPerson34

      Person, die der Schicht zugewiesen ist.

    • statusstring

      Status der Zuweisung, zum Beispiel zugewiesen oder storniert.

    • notestring

      Anmerkung zur Zuweisung.

Antworten

200VolunteerShiftAssignment aktualisierenVolunteerShiftAssignment

Felder anzeigen (8)
  • hour_entry_idinteger
  • idinteger

    Primärschlüssel der Ehrenamtsschicht-Zuordnung. Interne ID.

  • shiftVolunteerShift3

    Ehrenamtsschicht, zu der die Zuweisung gehört.

    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.

    • eventBaseEvent25

      Event, zu dem die Helferschicht gehört.

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

  • personCRMPerson27

    Person, die der Schicht zugewiesen ist.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

  • statusstring

    Status der Zuweisung, zum Beispiel zugewiesen oder storniert.

  • notestring

    Anmerkung zur Zuweisung.

  • cancelled_atstring (date-time)

    Zeitpunkt, zu dem die Zuordnung storniert wurde.

  • createdstring (date-time)

    Zeitpunkt, zu dem die Zuordnung angelegt wurde.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_shift_assignment/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "status": "string",
    "note": "string"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "hour_entry_id": 42,
  "shift": {
    "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
  },
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "number": 1,
    "manual_number": 1,
    "number_string": "string",
    "gender": "string",
    "nickname": "string",
    "preferred_color_hex": "string"
  },
  "status": "string",
  "note": "string",
  "cancelled_at": "2026-10-15T09:30:00+02:00",
  "created": "2026-10-15T09:30:00+02:00"
}

Einen Helfer aus einer Schicht entfernen, zusammen mit einem offenen Guthaben

DELETE/api/time/volunteer_shift_assignment/{id}

Pfad-Parameter

idPflichtstring

Antworten

default

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