Zum Inhalt springen
Developer

StaffingRequirement

Personal5 EndpunkteTimeTracking / StaffingRequirement

Diese Methode liefert alle StaffingRequirement-Objekte

GET/api/time/staffing_requirement

Query-Parameter

idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE | Standardwert: false
namestring
modestring
bufferModestringL53: HINT (Standard) reicht mit einem Hinweis ein, BLOCK lehnt einen Selbstbedienungsantrag ab, der den Tag unter Minimum + Puffer bringen würde. | Benötigt Zugriffs-Tag: SCOPE
employmentContractGroupstring
employmentOrganizationstring
organizationUnitstringR7: eine Regel für einen ganzen Bereich (OrganizationUnit) - jede Gruppe jeder Organisation darin oder darunter. Nur ohne Gruppe und Organisation, mit staffing_organization_unit_enabled. | Benötigt Zugriffsrecht: SCOPE
requiredQualificationstringOptionale Qualifikation, die die gezählten Personen erfüllen müssen (Gleichwertigkeiten und Rangfolge werden vom QualificationMatchHelper berücksichtigt).
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 StaffingRequirement-Objekte.array<StaffingRequirement>

Felder anzeigen (21)
  • idinteger

    Primärschlüssel des Besetzungsbedarfs. Interne ID.

  • employment_contract_groupEmploymentContractGroup

    Vertragsgruppe, für die die Anforderung gilt.

    Felder anzeigen (25)
    • staged_absence_approvalboolean

      null übernimmt die Organisation; false deaktiviert die gestufte Freigabe ausdrücklich.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Organisation, false schaltet es für diese Gruppe aus.

    • idinteger

      Primärschlüssel der Vertragsgruppe. Interne ID.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Arbeitstage pro Woche.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • allow_app_time_trackingboolean

      Ob die Zeiterfassung in der App erlaubt ist.

    • allow_scanner_time_trackingboolean

      Ob die Zeiterfassung per Scanner erlaubt ist.

    • allow_app_non_work_time_managementboolean

      Ob arbeitsfreie Zeit in der App verwaltet werden kann.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag dieser Gruppe vor seinem ersten Tag eingereicht werden muss. null greift auf die installationsweite Einstellung zurück – eine bestehende Gruppe verhält sich daher weiterhin genauso wie bisher.

    • school_holiday_regionSchoolHolidayRegion

      U09: der Schulkalender dieser Gruppe, wenn er vom Kalender der Organisation abweicht (Auszubildende, die in einem anderen Bundesland zur Schule gehen). null = der der Organisation.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

  • employment_organizationEmploymentOrganization

    Organisation, auf die sich die Anforderung bezieht.

    Felder anzeigen (12)
    • staged_absence_approvalboolean

      null übernimmt die Organisationsrichtlinie (Verträge); bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel der Beschäftigungsorganisation. Interne ID.

    • allow_app_time_trackingboolean

      Ob die Zeiterfassung in der App erlaubt ist.

    • school_holiday_regionSchoolHolidayRegion

      U09: der Schulkalender (Bundesland) dieser Organisation; Gruppen dürfen ihn überschreiben.

    • organization_unitOrganizationUnit4

      L01: der Knoten des Organisationsbaums, an dem diese Organisation hängt (Einrichtung, Bereich, Geschäftsstelle ...). Leitende dieses Knotens und der darüberliegenden Knoten leiten auch diese Organisation.

    • shift_booking_syncboolean

      L35: veröffentlichte Schichten der Personen dieser Organisation erscheinen als Verfügbarkeiten im Event-/Buchungsbereich, und eine Schicht kann in einen Termin umgewandelt werden. null = aus.

    • allow_scanner_time_trackingboolean

      Ob die Zeiterfassung per Scanner erlaubt ist.

    • allow_app_non_work_time_managementboolean

      Ob arbeitsfreie Zeit in der App verwaltet werden kann.

    • include_in_auto_exportboolean

      Ob die Organisation in den automatischen Export einbezogen wird.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • namestring

      Name der Einheit.

    • deletedboolean

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

  • organization_unitOrganizationUnit4

    R7: eine Regel für einen ganzen Bereich (OrganizationUnit) - jede Gruppe jeder Organisation darin oder darunter. Nur ohne Gruppe und Organisation, mit staffing_organization_unit_enabled.

    Felder anzeigen (11)
    • pathstring

      Die Pfadbezeichnung für Auswahlfelder und Listen: „Geschäftsstelle / Bereich Sport / Halle Nord“.

    • depthinteger
    • idinteger

      Primärschlüssel der Organisationseinheit. Interne ID.

    • levelstring

      Die Ebene, die dieser Knoten darstellt, Freitext (Geschäftsstelle, Bereich, Einrichtung, ...).

    • parentOrganizationUnit4

      Übergeordnete Organisation der Einheit.

    • sort_orderinteger

      Reihenfolge unter Geschwistern.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • modestring

    Art der Anforderung, zum Beispiel minimum staff oder exact staff.

  • weekdays_bitmaskinteger

    ISO-Wochentagsbitmaske, an der die Regel gilt (Mo=1 ... So=64).

  • start_timestring

    Startzeit des Bedarfs in HH:MM.

  • end_timestring

    Endzeit der Anforderung als HH:MM.

  • min_staff_countinteger

    Mindestanzahl benötigter Mitarbeitender.

  • buffer_staff_countinteger

    L51: zusätzlich gewünschte Personen über dem Minimum. Zwischen Minimum und Minimum + Puffer wird ein Selbstbedienungsantrag je nach bufferMode (L53) mit einem Hinweis für die Genehmiger eingereicht oder abgelehnt. 0 = kein Puffer.

  • buffer_modestring

    L53: HINT (Standard) reicht mit einem Hinweis ein, BLOCK lehnt einen Selbstbedienungsantrag ab, der den Tag unter Minimum + Puffer bringen würde.

  • required_qualificationEmploymentQualification4

    Optionale Qualifikation, die die gezählten Personen erfüllen müssen (Gleichwertigkeiten und Rangfolge werden vom QualificationMatchHelper berücksichtigt).

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel der Beschäftigungsqualifikation. Interne ID.

    • rankinginteger

      Rangfolge innerhalb eines Äquivalenznetzwerks - eine verknüpfte Qualifikation mit gleichem oder höherem Rang erfüllt auch Anforderungen an diese Qualifikation.

    • equivalent_qualificationsarray<EmploymentQualification4>

      Verknüpfte ("gleichwertige") Qualifikationen. Vom Controller symmetrisch gehalten: jede Verknüpfung A->B wird als B->A gespiegelt; der Rang entscheidet, welche Richtung tatsächlich welche abdeckt.

    • qualification_groupEmploymentQualificationGroup

      L17/A06: die "Schublade", zu der diese Qualifikation gehört. Mitglieder einer Gruppe decken sich gegenseitig die Anforderungen innerhalb ihres Rangs ab, wie es eine direkte Verknüpfung täte.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

  • qualification_match_modestring

    L18: EXACT verlangt die geforderte Qualifikation selbst; EQUIVALENT (Standard, bisheriges Verhalten) akzeptiert auch verknüpfte oder gleichgruppierte Qualifikationen mit ausreichendem Rang.

  • valid_fromstring (date-time)

    Regel gilt erst ab diesem Datum (null = immer).

  • valid_untilstring (date-time)

    Datum, bis zu dem die Anforderung gültig ist.

  • applies_on_holidaysboolean

    Ob die Regel auch an gesetzlichen Feiertagen des Kalenders ihres Geltungsbereichs gilt (Gruppenkalender, Organisationskalender, Hauptkalender). Standardmäßig aus: Eine geschlossene Kita oder ein geschlossenes Büro würde sonst an jedem Feiertag als unterbesetzt gemeldet; ein Verein oder eine Pflegeeinrichtung mit Feiertagsbetrieb schaltet sie ein.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • deletedboolean

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

  • namestring

    Name der Einheit.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/staffing_requirement \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "employment_contract_group": {
      "id": 42,
      "name": "Beispiel",
      "staged_absence_approval": true,
      "shift_booking_sync": true,
      "week_total_hours": 1.5,
      "week_total_days": 1.5,
      "year_vacation_days": 1.5,
      "month_vacation_days": 1.5,
      "year_vacation_weeks": 1.5,
      "monday_hours": 1.5
    },
    "employment_organization": {
      "id": 42,
      "name": "Beispiel",
      "staged_absence_approval": true,
      "allow_app_time_tracking": true,
      "shift_booking_sync": true,
      "allow_scanner_time_tracking": true,
      "allow_app_non_work_time_management": true,
      "include_in_auto_export": true,
      "search_string": "string",
      "deleted": true
    },
    "organization_unit": {
      "id": 42,
      "name": "Beispiel",
      "path": "string",
      "depth": 1,
      "level": "string",
      "sort_order": 1,
      "search_string": "string",
      "deleted": true,
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    },
    "mode": "string",
    "weekdays_bitmask": 1,
    "start_time": "string",
    "end_time": "string",
    "min_staff_count": 1
  }
]

StaffingRequirement neu anlegen

POST/api/time/staffing_requirement

Request-Body application/json

  • dataStaffingRequirement2
    Felder anzeigen (13)
    • modestring

      Art der Anforderung, zum Beispiel minimum staff oder exact staff.

    • weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske, an der die Regel gilt (Mo=1 ... So=64).

    • start_timestring

      Startzeit des Bedarfs in HH:MM.

    • end_timestring

      Endzeit der Anforderung als HH:MM.

    • min_staff_countinteger

      Mindestanzahl benötigter Mitarbeitender.

    • buffer_staff_countinteger

      L51: zusätzlich gewünschte Personen über dem Minimum. Zwischen Minimum und Minimum + Puffer wird ein Selbstbedienungsantrag je nach bufferMode (L53) mit einem Hinweis für die Genehmiger eingereicht oder abgelehnt. 0 = kein Puffer.

    • buffer_modestring

      L53: HINT (Standard) reicht mit einem Hinweis ein, BLOCK lehnt einen Selbstbedienungsantrag ab, der den Tag unter Minimum + Puffer bringen würde.

    • qualification_match_modestring

      L18: EXACT verlangt die geforderte Qualifikation selbst; EQUIVALENT (Standard, bisheriges Verhalten) akzeptiert auch verknüpfte oder gleichgruppierte Qualifikationen mit ausreichendem Rang.

    • valid_fromstring (date-time)

      Regel gilt erst ab diesem Datum (null = immer).

    • valid_untilstring (date-time)

      Datum, bis zu dem die Anforderung gültig ist.

    • applies_on_holidaysboolean

      Ob die Regel auch an gesetzlichen Feiertagen des Kalenders ihres Geltungsbereichs gilt (Gruppenkalender, Organisationskalender, Hauptkalender). Standardmäßig aus: Eine geschlossene Kita oder ein geschlossenes Büro würde sonst an jedem Feiertag als unterbesetzt gemeldet; ein Verein oder eine Pflegeeinrichtung mit Feiertagsbetrieb schaltet sie ein.

    • deletedboolean

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

    • namestring

      Name der Einheit.

Antworten

200StaffingRequirement neu anlegenStaffingRequirement3

Felder anzeigen (21)
  • idinteger

    Primärschlüssel des Besetzungsbedarfs. Interne ID.

  • employment_contract_groupEmploymentContractGroup

    Vertragsgruppe, für die die Anforderung gilt.

    Felder anzeigen (25)
    • staged_absence_approvalboolean

      null übernimmt die Organisation; false deaktiviert die gestufte Freigabe ausdrücklich.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Organisation, false schaltet es für diese Gruppe aus.

    • idinteger

      Primärschlüssel der Vertragsgruppe. Interne ID.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Arbeitstage pro Woche.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • allow_app_time_trackingboolean

      Ob die Zeiterfassung in der App erlaubt ist.

    • allow_scanner_time_trackingboolean

      Ob die Zeiterfassung per Scanner erlaubt ist.

    • allow_app_non_work_time_managementboolean

      Ob arbeitsfreie Zeit in der App verwaltet werden kann.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag dieser Gruppe vor seinem ersten Tag eingereicht werden muss. null greift auf die installationsweite Einstellung zurück – eine bestehende Gruppe verhält sich daher weiterhin genauso wie bisher.

    • school_holiday_regionSchoolHolidayRegion

      U09: der Schulkalender dieser Gruppe, wenn er vom Kalender der Organisation abweicht (Auszubildende, die in einem anderen Bundesland zur Schule gehen). null = der der Organisation.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

  • employment_organizationEmploymentOrganization2

    Organisation, auf die sich die Anforderung bezieht.

    Felder anzeigen (12)
    • staged_absence_approvalboolean

      null übernimmt die Organisationsrichtlinie (Verträge); bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel der Beschäftigungsorganisation. Interne ID.

    • allow_app_time_trackingboolean

      Ob die Zeiterfassung in der App erlaubt ist.

    • school_holiday_regionSchoolHolidayRegion

      U09: der Schulkalender (Bundesland) dieser Organisation; Gruppen dürfen ihn überschreiben.

    • organization_unitOrganizationUnit5

      L01: der Knoten des Organisationsbaums, an dem diese Organisation hängt (Einrichtung, Bereich, Geschäftsstelle ...). Leitende dieses Knotens und der darüberliegenden Knoten leiten auch diese Organisation.

    • shift_booking_syncboolean

      L35: veröffentlichte Schichten der Personen dieser Organisation erscheinen als Verfügbarkeiten im Event-/Buchungsbereich, und eine Schicht kann in einen Termin umgewandelt werden. null = aus.

    • allow_scanner_time_trackingboolean

      Ob die Zeiterfassung per Scanner erlaubt ist.

    • allow_app_non_work_time_managementboolean

      Ob arbeitsfreie Zeit in der App verwaltet werden kann.

    • include_in_auto_exportboolean

      Ob die Organisation in den automatischen Export einbezogen wird.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • namestring

      Name der Einheit.

    • deletedboolean

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

  • organization_unitOrganizationUnit5

    R7: eine Regel für einen ganzen Bereich (OrganizationUnit) - jede Gruppe jeder Organisation darin oder darunter. Nur ohne Gruppe und Organisation, mit staffing_organization_unit_enabled.

    Felder anzeigen (13)
    • pathstring

      Die Pfadbezeichnung für Auswahlfelder und Listen: „Geschäftsstelle / Bereich Sport / Halle Nord“.

    • depthinteger
    • idinteger

      Primärschlüssel der Organisationseinheit. Interne ID.

    • levelstring

      Die Ebene, die dieser Knoten darstellt, Freitext (Geschäftsstelle, Bereich, Einrichtung, ...).

    • parentOrganizationUnit5

      Übergeordnete Organisation der Einheit.

    • leadershiparray<CRMPerson10>

      Leitende dieses Knotens; sie leiten alles darunter.

    • staffing_alarm_recipientsarray<CRMPerson10>

      R7: wer benachrichtigt wird, wenn eine Besetzungsregel in diesem Bereich unter ihr Minimum fällt; leer = der nächsthöhere Bereich, am Ende staffing_alarm_recipient_persons.

    • sort_orderinteger

      Reihenfolge unter Geschwistern.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • modestring

    Art der Anforderung, zum Beispiel minimum staff oder exact staff.

  • weekdays_bitmaskinteger

    ISO-Wochentagsbitmaske, an der die Regel gilt (Mo=1 ... So=64).

  • start_timestring

    Startzeit des Bedarfs in HH:MM.

  • end_timestring

    Endzeit der Anforderung als HH:MM.

  • min_staff_countinteger

    Mindestanzahl benötigter Mitarbeitender.

  • buffer_staff_countinteger

    L51: zusätzlich gewünschte Personen über dem Minimum. Zwischen Minimum und Minimum + Puffer wird ein Selbstbedienungsantrag je nach bufferMode (L53) mit einem Hinweis für die Genehmiger eingereicht oder abgelehnt. 0 = kein Puffer.

  • buffer_modestring

    L53: HINT (Standard) reicht mit einem Hinweis ein, BLOCK lehnt einen Selbstbedienungsantrag ab, der den Tag unter Minimum + Puffer bringen würde.

  • required_qualificationEmploymentQualification

    Optionale Qualifikation, die die gezählten Personen erfüllen müssen (Gleichwertigkeiten und Rangfolge werden vom QualificationMatchHelper berücksichtigt).

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel der Beschäftigungsqualifikation. Interne ID.

    • rankinginteger

      Rangfolge innerhalb eines Äquivalenznetzwerks - eine verknüpfte Qualifikation mit gleichem oder höherem Rang erfüllt auch Anforderungen an diese Qualifikation.

    • equivalent_qualificationsarray<EmploymentQualification>

      Verknüpfte ("gleichwertige") Qualifikationen. Vom Controller symmetrisch gehalten: jede Verknüpfung A->B wird als B->A gespiegelt; der Rang entscheidet, welche Richtung tatsächlich welche abdeckt.

    • qualification_groupEmploymentQualificationGroup

      L17/A06: die "Schublade", zu der diese Qualifikation gehört. Mitglieder einer Gruppe decken sich gegenseitig die Anforderungen innerhalb ihres Rangs ab, wie es eine direkte Verknüpfung täte.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

  • qualification_match_modestring

    L18: EXACT verlangt die geforderte Qualifikation selbst; EQUIVALENT (Standard, bisheriges Verhalten) akzeptiert auch verknüpfte oder gleichgruppierte Qualifikationen mit ausreichendem Rang.

  • valid_fromstring (date-time)

    Regel gilt erst ab diesem Datum (null = immer).

  • valid_untilstring (date-time)

    Datum, bis zu dem die Anforderung gültig ist.

  • applies_on_holidaysboolean

    Ob die Regel auch an gesetzlichen Feiertagen des Kalenders ihres Geltungsbereichs gilt (Gruppenkalender, Organisationskalender, Hauptkalender). Standardmäßig aus: Eine geschlossene Kita oder ein geschlossenes Büro würde sonst an jedem Feiertag als unterbesetzt gemeldet; ein Verein oder eine Pflegeeinrichtung mit Feiertagsbetrieb schaltet sie ein.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • deletedboolean

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

  • namestring

    Name der Einheit.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/time/staffing_requirement \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "mode": "string",
    "weekdays_bitmask": 1,
    "start_time": "string",
    "end_time": "string",
    "min_staff_count": 1
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "employment_contract_group": {
    "id": 42,
    "name": "Beispiel",
    "staged_absence_approval": true,
    "shift_booking_sync": true,
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "year_vacation_days": 1.5,
    "month_vacation_days": 1.5,
    "year_vacation_weeks": 1.5,
    "monday_hours": 1.5
  },
  "employment_organization": {
    "id": 42,
    "name": "Beispiel",
    "staged_absence_approval": true,
    "allow_app_time_tracking": true,
    "school_holiday_region": {
      "id": 42,
      "name": "Beispiel",
      "region_code": "string",
      "sort_order": 1,
      "search_string": "string",
      "deleted": true,
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    },
    "organization_unit": {
      "id": 42,
      "name": "Beispiel",
      "path": "string",
      "depth": 1,
      "level": "string",
      "sort_order": 1,
      "search_string": "string",
      "deleted": true,
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    },
    "shift_booking_sync": true,
    "allow_scanner_time_tracking": true,
    "allow_app_non_work_time_management": true,
    "include_in_auto_export": true
  },
  "organization_unit": {
    "id": 42,
    "name": "Beispiel",
    "path": "string",
    "depth": 1,
    "level": "string",
    "sort_order": 1,
    "search_string": "string",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "mode": "string",
  "weekdays_bitmask": 1,
  "start_time": "string",
  "end_time": "string",
  "min_staff_count": 1
}

Diese Methode liefert eine einzelne StaffingRequirement mit der angegebenen ID

GET/api/time/staffing_requirement/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert ein einzelnes StaffingRequirement-Objekt.StaffingRequirement3

Felder anzeigen (21)
  • idinteger

    Primärschlüssel des Besetzungsbedarfs. Interne ID.

  • employment_contract_groupEmploymentContractGroup

    Vertragsgruppe, für die die Anforderung gilt.

    Felder anzeigen (25)
    • staged_absence_approvalboolean

      null übernimmt die Organisation; false deaktiviert die gestufte Freigabe ausdrücklich.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Organisation, false schaltet es für diese Gruppe aus.

    • idinteger

      Primärschlüssel der Vertragsgruppe. Interne ID.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Arbeitstage pro Woche.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • allow_app_time_trackingboolean

      Ob die Zeiterfassung in der App erlaubt ist.

    • allow_scanner_time_trackingboolean

      Ob die Zeiterfassung per Scanner erlaubt ist.

    • allow_app_non_work_time_managementboolean

      Ob arbeitsfreie Zeit in der App verwaltet werden kann.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag dieser Gruppe vor seinem ersten Tag eingereicht werden muss. null greift auf die installationsweite Einstellung zurück – eine bestehende Gruppe verhält sich daher weiterhin genauso wie bisher.

    • school_holiday_regionSchoolHolidayRegion

      U09: der Schulkalender dieser Gruppe, wenn er vom Kalender der Organisation abweicht (Auszubildende, die in einem anderen Bundesland zur Schule gehen). null = der der Organisation.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

  • employment_organizationEmploymentOrganization2

    Organisation, auf die sich die Anforderung bezieht.

    Felder anzeigen (12)
    • staged_absence_approvalboolean

      null übernimmt die Organisationsrichtlinie (Verträge); bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel der Beschäftigungsorganisation. Interne ID.

    • allow_app_time_trackingboolean

      Ob die Zeiterfassung in der App erlaubt ist.

    • school_holiday_regionSchoolHolidayRegion

      U09: der Schulkalender (Bundesland) dieser Organisation; Gruppen dürfen ihn überschreiben.

    • organization_unitOrganizationUnit5

      L01: der Knoten des Organisationsbaums, an dem diese Organisation hängt (Einrichtung, Bereich, Geschäftsstelle ...). Leitende dieses Knotens und der darüberliegenden Knoten leiten auch diese Organisation.

    • shift_booking_syncboolean

      L35: veröffentlichte Schichten der Personen dieser Organisation erscheinen als Verfügbarkeiten im Event-/Buchungsbereich, und eine Schicht kann in einen Termin umgewandelt werden. null = aus.

    • allow_scanner_time_trackingboolean

      Ob die Zeiterfassung per Scanner erlaubt ist.

    • allow_app_non_work_time_managementboolean

      Ob arbeitsfreie Zeit in der App verwaltet werden kann.

    • include_in_auto_exportboolean

      Ob die Organisation in den automatischen Export einbezogen wird.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • namestring

      Name der Einheit.

    • deletedboolean

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

  • organization_unitOrganizationUnit5

    R7: eine Regel für einen ganzen Bereich (OrganizationUnit) - jede Gruppe jeder Organisation darin oder darunter. Nur ohne Gruppe und Organisation, mit staffing_organization_unit_enabled.

    Felder anzeigen (13)
    • pathstring

      Die Pfadbezeichnung für Auswahlfelder und Listen: „Geschäftsstelle / Bereich Sport / Halle Nord“.

    • depthinteger
    • idinteger

      Primärschlüssel der Organisationseinheit. Interne ID.

    • levelstring

      Die Ebene, die dieser Knoten darstellt, Freitext (Geschäftsstelle, Bereich, Einrichtung, ...).

    • parentOrganizationUnit5

      Übergeordnete Organisation der Einheit.

    • leadershiparray<CRMPerson10>

      Leitende dieses Knotens; sie leiten alles darunter.

    • staffing_alarm_recipientsarray<CRMPerson10>

      R7: wer benachrichtigt wird, wenn eine Besetzungsregel in diesem Bereich unter ihr Minimum fällt; leer = der nächsthöhere Bereich, am Ende staffing_alarm_recipient_persons.

    • sort_orderinteger

      Reihenfolge unter Geschwistern.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • modestring

    Art der Anforderung, zum Beispiel minimum staff oder exact staff.

  • weekdays_bitmaskinteger

    ISO-Wochentagsbitmaske, an der die Regel gilt (Mo=1 ... So=64).

  • start_timestring

    Startzeit des Bedarfs in HH:MM.

  • end_timestring

    Endzeit der Anforderung als HH:MM.

  • min_staff_countinteger

    Mindestanzahl benötigter Mitarbeitender.

  • buffer_staff_countinteger

    L51: zusätzlich gewünschte Personen über dem Minimum. Zwischen Minimum und Minimum + Puffer wird ein Selbstbedienungsantrag je nach bufferMode (L53) mit einem Hinweis für die Genehmiger eingereicht oder abgelehnt. 0 = kein Puffer.

  • buffer_modestring

    L53: HINT (Standard) reicht mit einem Hinweis ein, BLOCK lehnt einen Selbstbedienungsantrag ab, der den Tag unter Minimum + Puffer bringen würde.

  • required_qualificationEmploymentQualification

    Optionale Qualifikation, die die gezählten Personen erfüllen müssen (Gleichwertigkeiten und Rangfolge werden vom QualificationMatchHelper berücksichtigt).

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel der Beschäftigungsqualifikation. Interne ID.

    • rankinginteger

      Rangfolge innerhalb eines Äquivalenznetzwerks - eine verknüpfte Qualifikation mit gleichem oder höherem Rang erfüllt auch Anforderungen an diese Qualifikation.

    • equivalent_qualificationsarray<EmploymentQualification>

      Verknüpfte ("gleichwertige") Qualifikationen. Vom Controller symmetrisch gehalten: jede Verknüpfung A->B wird als B->A gespiegelt; der Rang entscheidet, welche Richtung tatsächlich welche abdeckt.

    • qualification_groupEmploymentQualificationGroup

      L17/A06: die "Schublade", zu der diese Qualifikation gehört. Mitglieder einer Gruppe decken sich gegenseitig die Anforderungen innerhalb ihres Rangs ab, wie es eine direkte Verknüpfung täte.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

  • qualification_match_modestring

    L18: EXACT verlangt die geforderte Qualifikation selbst; EQUIVALENT (Standard, bisheriges Verhalten) akzeptiert auch verknüpfte oder gleichgruppierte Qualifikationen mit ausreichendem Rang.

  • valid_fromstring (date-time)

    Regel gilt erst ab diesem Datum (null = immer).

  • valid_untilstring (date-time)

    Datum, bis zu dem die Anforderung gültig ist.

  • applies_on_holidaysboolean

    Ob die Regel auch an gesetzlichen Feiertagen des Kalenders ihres Geltungsbereichs gilt (Gruppenkalender, Organisationskalender, Hauptkalender). Standardmäßig aus: Eine geschlossene Kita oder ein geschlossenes Büro würde sonst an jedem Feiertag als unterbesetzt gemeldet; ein Verein oder eine Pflegeeinrichtung mit Feiertagsbetrieb schaltet sie ein.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • deletedboolean

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

  • namestring

    Name der Einheit.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/staffing_requirement/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "employment_contract_group": {
    "id": 42,
    "name": "Beispiel",
    "staged_absence_approval": true,
    "shift_booking_sync": true,
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "year_vacation_days": 1.5,
    "month_vacation_days": 1.5,
    "year_vacation_weeks": 1.5,
    "monday_hours": 1.5
  },
  "employment_organization": {
    "id": 42,
    "name": "Beispiel",
    "staged_absence_approval": true,
    "allow_app_time_tracking": true,
    "school_holiday_region": {
      "id": 42,
      "name": "Beispiel",
      "region_code": "string",
      "sort_order": 1,
      "search_string": "string",
      "deleted": true,
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    },
    "organization_unit": {
      "id": 42,
      "name": "Beispiel",
      "path": "string",
      "depth": 1,
      "level": "string",
      "sort_order": 1,
      "search_string": "string",
      "deleted": true,
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    },
    "shift_booking_sync": true,
    "allow_scanner_time_tracking": true,
    "allow_app_non_work_time_management": true,
    "include_in_auto_export": true
  },
  "organization_unit": {
    "id": 42,
    "name": "Beispiel",
    "path": "string",
    "depth": 1,
    "level": "string",
    "sort_order": 1,
    "search_string": "string",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "mode": "string",
  "weekdays_bitmask": 1,
  "start_time": "string",
  "end_time": "string",
  "min_staff_count": 1
}

StaffingRequirement aktualisieren

PUT/api/time/staffing_requirement/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataStaffingRequirement2
    Felder anzeigen (13)
    • modestring

      Art der Anforderung, zum Beispiel minimum staff oder exact staff.

    • weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske, an der die Regel gilt (Mo=1 ... So=64).

    • start_timestring

      Startzeit des Bedarfs in HH:MM.

    • end_timestring

      Endzeit der Anforderung als HH:MM.

    • min_staff_countinteger

      Mindestanzahl benötigter Mitarbeitender.

    • buffer_staff_countinteger

      L51: zusätzlich gewünschte Personen über dem Minimum. Zwischen Minimum und Minimum + Puffer wird ein Selbstbedienungsantrag je nach bufferMode (L53) mit einem Hinweis für die Genehmiger eingereicht oder abgelehnt. 0 = kein Puffer.

    • buffer_modestring

      L53: HINT (Standard) reicht mit einem Hinweis ein, BLOCK lehnt einen Selbstbedienungsantrag ab, der den Tag unter Minimum + Puffer bringen würde.

    • qualification_match_modestring

      L18: EXACT verlangt die geforderte Qualifikation selbst; EQUIVALENT (Standard, bisheriges Verhalten) akzeptiert auch verknüpfte oder gleichgruppierte Qualifikationen mit ausreichendem Rang.

    • valid_fromstring (date-time)

      Regel gilt erst ab diesem Datum (null = immer).

    • valid_untilstring (date-time)

      Datum, bis zu dem die Anforderung gültig ist.

    • applies_on_holidaysboolean

      Ob die Regel auch an gesetzlichen Feiertagen des Kalenders ihres Geltungsbereichs gilt (Gruppenkalender, Organisationskalender, Hauptkalender). Standardmäßig aus: Eine geschlossene Kita oder ein geschlossenes Büro würde sonst an jedem Feiertag als unterbesetzt gemeldet; ein Verein oder eine Pflegeeinrichtung mit Feiertagsbetrieb schaltet sie ein.

    • deletedboolean

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

    • namestring

      Name der Einheit.

Antworten

200StaffingRequirement aktualisierenStaffingRequirement3

Felder anzeigen (21)
  • idinteger

    Primärschlüssel des Besetzungsbedarfs. Interne ID.

  • employment_contract_groupEmploymentContractGroup

    Vertragsgruppe, für die die Anforderung gilt.

    Felder anzeigen (25)
    • staged_absence_approvalboolean

      null übernimmt die Organisation; false deaktiviert die gestufte Freigabe ausdrücklich.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Organisation, false schaltet es für diese Gruppe aus.

    • idinteger

      Primärschlüssel der Vertragsgruppe. Interne ID.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Arbeitstage pro Woche.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • allow_app_time_trackingboolean

      Ob die Zeiterfassung in der App erlaubt ist.

    • allow_scanner_time_trackingboolean

      Ob die Zeiterfassung per Scanner erlaubt ist.

    • allow_app_non_work_time_managementboolean

      Ob arbeitsfreie Zeit in der App verwaltet werden kann.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag dieser Gruppe vor seinem ersten Tag eingereicht werden muss. null greift auf die installationsweite Einstellung zurück – eine bestehende Gruppe verhält sich daher weiterhin genauso wie bisher.

    • school_holiday_regionSchoolHolidayRegion

      U09: der Schulkalender dieser Gruppe, wenn er vom Kalender der Organisation abweicht (Auszubildende, die in einem anderen Bundesland zur Schule gehen). null = der der Organisation.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

  • employment_organizationEmploymentOrganization2

    Organisation, auf die sich die Anforderung bezieht.

    Felder anzeigen (12)
    • staged_absence_approvalboolean

      null übernimmt die Organisationsrichtlinie (Verträge); bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel der Beschäftigungsorganisation. Interne ID.

    • allow_app_time_trackingboolean

      Ob die Zeiterfassung in der App erlaubt ist.

    • school_holiday_regionSchoolHolidayRegion

      U09: der Schulkalender (Bundesland) dieser Organisation; Gruppen dürfen ihn überschreiben.

    • organization_unitOrganizationUnit5

      L01: der Knoten des Organisationsbaums, an dem diese Organisation hängt (Einrichtung, Bereich, Geschäftsstelle ...). Leitende dieses Knotens und der darüberliegenden Knoten leiten auch diese Organisation.

    • shift_booking_syncboolean

      L35: veröffentlichte Schichten der Personen dieser Organisation erscheinen als Verfügbarkeiten im Event-/Buchungsbereich, und eine Schicht kann in einen Termin umgewandelt werden. null = aus.

    • allow_scanner_time_trackingboolean

      Ob die Zeiterfassung per Scanner erlaubt ist.

    • allow_app_non_work_time_managementboolean

      Ob arbeitsfreie Zeit in der App verwaltet werden kann.

    • include_in_auto_exportboolean

      Ob die Organisation in den automatischen Export einbezogen wird.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • namestring

      Name der Einheit.

    • deletedboolean

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

  • organization_unitOrganizationUnit5

    R7: eine Regel für einen ganzen Bereich (OrganizationUnit) - jede Gruppe jeder Organisation darin oder darunter. Nur ohne Gruppe und Organisation, mit staffing_organization_unit_enabled.

    Felder anzeigen (13)
    • pathstring

      Die Pfadbezeichnung für Auswahlfelder und Listen: „Geschäftsstelle / Bereich Sport / Halle Nord“.

    • depthinteger
    • idinteger

      Primärschlüssel der Organisationseinheit. Interne ID.

    • levelstring

      Die Ebene, die dieser Knoten darstellt, Freitext (Geschäftsstelle, Bereich, Einrichtung, ...).

    • parentOrganizationUnit5

      Übergeordnete Organisation der Einheit.

    • leadershiparray<CRMPerson10>

      Leitende dieses Knotens; sie leiten alles darunter.

    • staffing_alarm_recipientsarray<CRMPerson10>

      R7: wer benachrichtigt wird, wenn eine Besetzungsregel in diesem Bereich unter ihr Minimum fällt; leer = der nächsthöhere Bereich, am Ende staffing_alarm_recipient_persons.

    • sort_orderinteger

      Reihenfolge unter Geschwistern.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • modestring

    Art der Anforderung, zum Beispiel minimum staff oder exact staff.

  • weekdays_bitmaskinteger

    ISO-Wochentagsbitmaske, an der die Regel gilt (Mo=1 ... So=64).

  • start_timestring

    Startzeit des Bedarfs in HH:MM.

  • end_timestring

    Endzeit der Anforderung als HH:MM.

  • min_staff_countinteger

    Mindestanzahl benötigter Mitarbeitender.

  • buffer_staff_countinteger

    L51: zusätzlich gewünschte Personen über dem Minimum. Zwischen Minimum und Minimum + Puffer wird ein Selbstbedienungsantrag je nach bufferMode (L53) mit einem Hinweis für die Genehmiger eingereicht oder abgelehnt. 0 = kein Puffer.

  • buffer_modestring

    L53: HINT (Standard) reicht mit einem Hinweis ein, BLOCK lehnt einen Selbstbedienungsantrag ab, der den Tag unter Minimum + Puffer bringen würde.

  • required_qualificationEmploymentQualification

    Optionale Qualifikation, die die gezählten Personen erfüllen müssen (Gleichwertigkeiten und Rangfolge werden vom QualificationMatchHelper berücksichtigt).

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel der Beschäftigungsqualifikation. Interne ID.

    • rankinginteger

      Rangfolge innerhalb eines Äquivalenznetzwerks - eine verknüpfte Qualifikation mit gleichem oder höherem Rang erfüllt auch Anforderungen an diese Qualifikation.

    • equivalent_qualificationsarray<EmploymentQualification>

      Verknüpfte ("gleichwertige") Qualifikationen. Vom Controller symmetrisch gehalten: jede Verknüpfung A->B wird als B->A gespiegelt; der Rang entscheidet, welche Richtung tatsächlich welche abdeckt.

    • qualification_groupEmploymentQualificationGroup

      L17/A06: die "Schublade", zu der diese Qualifikation gehört. Mitglieder einer Gruppe decken sich gegenseitig die Anforderungen innerhalb ihres Rangs ab, wie es eine direkte Verknüpfung täte.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

  • qualification_match_modestring

    L18: EXACT verlangt die geforderte Qualifikation selbst; EQUIVALENT (Standard, bisheriges Verhalten) akzeptiert auch verknüpfte oder gleichgruppierte Qualifikationen mit ausreichendem Rang.

  • valid_fromstring (date-time)

    Regel gilt erst ab diesem Datum (null = immer).

  • valid_untilstring (date-time)

    Datum, bis zu dem die Anforderung gültig ist.

  • applies_on_holidaysboolean

    Ob die Regel auch an gesetzlichen Feiertagen des Kalenders ihres Geltungsbereichs gilt (Gruppenkalender, Organisationskalender, Hauptkalender). Standardmäßig aus: Eine geschlossene Kita oder ein geschlossenes Büro würde sonst an jedem Feiertag als unterbesetzt gemeldet; ein Verein oder eine Pflegeeinrichtung mit Feiertagsbetrieb schaltet sie ein.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • deletedboolean

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

  • namestring

    Name der Einheit.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/time/staffing_requirement/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "mode": "string",
    "weekdays_bitmask": 1,
    "start_time": "string",
    "end_time": "string",
    "min_staff_count": 1
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "employment_contract_group": {
    "id": 42,
    "name": "Beispiel",
    "staged_absence_approval": true,
    "shift_booking_sync": true,
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "year_vacation_days": 1.5,
    "month_vacation_days": 1.5,
    "year_vacation_weeks": 1.5,
    "monday_hours": 1.5
  },
  "employment_organization": {
    "id": 42,
    "name": "Beispiel",
    "staged_absence_approval": true,
    "allow_app_time_tracking": true,
    "school_holiday_region": {
      "id": 42,
      "name": "Beispiel",
      "region_code": "string",
      "sort_order": 1,
      "search_string": "string",
      "deleted": true,
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    },
    "organization_unit": {
      "id": 42,
      "name": "Beispiel",
      "path": "string",
      "depth": 1,
      "level": "string",
      "sort_order": 1,
      "search_string": "string",
      "deleted": true,
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    },
    "shift_booking_sync": true,
    "allow_scanner_time_tracking": true,
    "allow_app_non_work_time_management": true,
    "include_in_auto_export": true
  },
  "organization_unit": {
    "id": 42,
    "name": "Beispiel",
    "path": "string",
    "depth": 1,
    "level": "string",
    "sort_order": 1,
    "search_string": "string",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "mode": "string",
  "weekdays_bitmask": 1,
  "start_time": "string",
  "end_time": "string",
  "min_staff_count": 1
}

StaffingRequirement aktualisieren

PATCH/api/time/staffing_requirement/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataStaffingRequirement2
    Felder anzeigen (13)
    • modestring

      Art der Anforderung, zum Beispiel minimum staff oder exact staff.

    • weekdays_bitmaskinteger

      ISO-Wochentagsbitmaske, an der die Regel gilt (Mo=1 ... So=64).

    • start_timestring

      Startzeit des Bedarfs in HH:MM.

    • end_timestring

      Endzeit der Anforderung als HH:MM.

    • min_staff_countinteger

      Mindestanzahl benötigter Mitarbeitender.

    • buffer_staff_countinteger

      L51: zusätzlich gewünschte Personen über dem Minimum. Zwischen Minimum und Minimum + Puffer wird ein Selbstbedienungsantrag je nach bufferMode (L53) mit einem Hinweis für die Genehmiger eingereicht oder abgelehnt. 0 = kein Puffer.

    • buffer_modestring

      L53: HINT (Standard) reicht mit einem Hinweis ein, BLOCK lehnt einen Selbstbedienungsantrag ab, der den Tag unter Minimum + Puffer bringen würde.

    • qualification_match_modestring

      L18: EXACT verlangt die geforderte Qualifikation selbst; EQUIVALENT (Standard, bisheriges Verhalten) akzeptiert auch verknüpfte oder gleichgruppierte Qualifikationen mit ausreichendem Rang.

    • valid_fromstring (date-time)

      Regel gilt erst ab diesem Datum (null = immer).

    • valid_untilstring (date-time)

      Datum, bis zu dem die Anforderung gültig ist.

    • applies_on_holidaysboolean

      Ob die Regel auch an gesetzlichen Feiertagen des Kalenders ihres Geltungsbereichs gilt (Gruppenkalender, Organisationskalender, Hauptkalender). Standardmäßig aus: Eine geschlossene Kita oder ein geschlossenes Büro würde sonst an jedem Feiertag als unterbesetzt gemeldet; ein Verein oder eine Pflegeeinrichtung mit Feiertagsbetrieb schaltet sie ein.

    • deletedboolean

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

    • namestring

      Name der Einheit.

Antworten

200StaffingRequirement aktualisierenStaffingRequirement3

Felder anzeigen (21)
  • idinteger

    Primärschlüssel des Besetzungsbedarfs. Interne ID.

  • employment_contract_groupEmploymentContractGroup

    Vertragsgruppe, für die die Anforderung gilt.

    Felder anzeigen (25)
    • staged_absence_approvalboolean

      null übernimmt die Organisation; false deaktiviert die gestufte Freigabe ausdrücklich.

    • shift_booking_syncboolean

      L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Organisation, false schaltet es für diese Gruppe aus.

    • idinteger

      Primärschlüssel der Vertragsgruppe. Interne ID.

    • week_total_hoursnumber (float)

      Gesamte Arbeitsstunden pro Woche.

    • week_total_daysnumber (float)

      Arbeitstage pro Woche.

    • year_vacation_daysnumber (float)

      Urlaubstage pro Jahr.

    • month_vacation_daysnumber (float)

      Urlaubstage pro Monat.

    • year_vacation_weeksnumber (float)

      Urlaubswochen pro Jahr.

    • monday_hoursnumber (float)

      Arbeitsstunden am Montag.

    • tuesday_hoursnumber (float)

      Arbeitsstunden am Dienstag.

    • wednesday_hoursnumber (float)

      Arbeitsstunden am Mittwoch.

    • thursday_hoursnumber (float)

      Arbeitsstunden am Donnerstag.

    • friday_hoursnumber (float)

      Arbeitsstunden am Freitag.

    • saturday_hoursnumber (float)

      Arbeitsstunden am Samstag.

    • sunday_hoursnumber (float)

      Arbeitsstunden am Sonntag.

    • netto_hour_costnumber (float)

      Nettokosten je Stunde.

    • brutto_hour_costnumber (float)

      Bruttokosten pro Stunde.

    • allow_app_time_trackingboolean

      Ob die Zeiterfassung in der App erlaubt ist.

    • allow_scanner_time_trackingboolean

      Ob die Zeiterfassung per Scanner erlaubt ist.

    • allow_app_non_work_time_managementboolean

      Ob arbeitsfreie Zeit in der App verwaltet werden kann.

    • request_lead_time_daysinteger

      Tage, die ein Abwesenheitsantrag dieser Gruppe vor seinem ersten Tag eingereicht werden muss. null greift auf die installationsweite Einstellung zurück – eine bestehende Gruppe verhält sich daher weiterhin genauso wie bisher.

    • school_holiday_regionSchoolHolidayRegion

      U09: der Schulkalender dieser Gruppe, wenn er vom Kalender der Organisation abweicht (Auszubildende, die in einem anderen Bundesland zur Schule gehen). null = der der Organisation.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

  • employment_organizationEmploymentOrganization2

    Organisation, auf die sich die Anforderung bezieht.

    Felder anzeigen (12)
    • staged_absence_approvalboolean

      null übernimmt die Organisationsrichtlinie (Verträge); bestehende Installationen bleiben aus.

    • idinteger

      Primärschlüssel der Beschäftigungsorganisation. Interne ID.

    • allow_app_time_trackingboolean

      Ob die Zeiterfassung in der App erlaubt ist.

    • school_holiday_regionSchoolHolidayRegion

      U09: der Schulkalender (Bundesland) dieser Organisation; Gruppen dürfen ihn überschreiben.

    • organization_unitOrganizationUnit5

      L01: der Knoten des Organisationsbaums, an dem diese Organisation hängt (Einrichtung, Bereich, Geschäftsstelle ...). Leitende dieses Knotens und der darüberliegenden Knoten leiten auch diese Organisation.

    • shift_booking_syncboolean

      L35: veröffentlichte Schichten der Personen dieser Organisation erscheinen als Verfügbarkeiten im Event-/Buchungsbereich, und eine Schicht kann in einen Termin umgewandelt werden. null = aus.

    • allow_scanner_time_trackingboolean

      Ob die Zeiterfassung per Scanner erlaubt ist.

    • allow_app_non_work_time_managementboolean

      Ob arbeitsfreie Zeit in der App verwaltet werden kann.

    • include_in_auto_exportboolean

      Ob die Organisation in den automatischen Export einbezogen wird.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • namestring

      Name der Einheit.

    • deletedboolean

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

  • organization_unitOrganizationUnit5

    R7: eine Regel für einen ganzen Bereich (OrganizationUnit) - jede Gruppe jeder Organisation darin oder darunter. Nur ohne Gruppe und Organisation, mit staffing_organization_unit_enabled.

    Felder anzeigen (13)
    • pathstring

      Die Pfadbezeichnung für Auswahlfelder und Listen: „Geschäftsstelle / Bereich Sport / Halle Nord“.

    • depthinteger
    • idinteger

      Primärschlüssel der Organisationseinheit. Interne ID.

    • levelstring

      Die Ebene, die dieser Knoten darstellt, Freitext (Geschäftsstelle, Bereich, Einrichtung, ...).

    • parentOrganizationUnit5

      Übergeordnete Organisation der Einheit.

    • leadershiparray<CRMPerson10>

      Leitende dieses Knotens; sie leiten alles darunter.

    • staffing_alarm_recipientsarray<CRMPerson10>

      R7: wer benachrichtigt wird, wenn eine Besetzungsregel in diesem Bereich unter ihr Minimum fällt; leer = der nächsthöhere Bereich, am Ende staffing_alarm_recipient_persons.

    • sort_orderinteger

      Reihenfolge unter Geschwistern.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • modestring

    Art der Anforderung, zum Beispiel minimum staff oder exact staff.

  • weekdays_bitmaskinteger

    ISO-Wochentagsbitmaske, an der die Regel gilt (Mo=1 ... So=64).

  • start_timestring

    Startzeit des Bedarfs in HH:MM.

  • end_timestring

    Endzeit der Anforderung als HH:MM.

  • min_staff_countinteger

    Mindestanzahl benötigter Mitarbeitender.

  • buffer_staff_countinteger

    L51: zusätzlich gewünschte Personen über dem Minimum. Zwischen Minimum und Minimum + Puffer wird ein Selbstbedienungsantrag je nach bufferMode (L53) mit einem Hinweis für die Genehmiger eingereicht oder abgelehnt. 0 = kein Puffer.

  • buffer_modestring

    L53: HINT (Standard) reicht mit einem Hinweis ein, BLOCK lehnt einen Selbstbedienungsantrag ab, der den Tag unter Minimum + Puffer bringen würde.

  • required_qualificationEmploymentQualification

    Optionale Qualifikation, die die gezählten Personen erfüllen müssen (Gleichwertigkeiten und Rangfolge werden vom QualificationMatchHelper berücksichtigt).

    Felder anzeigen (7)
    • idinteger

      Primärschlüssel der Beschäftigungsqualifikation. Interne ID.

    • rankinginteger

      Rangfolge innerhalb eines Äquivalenznetzwerks - eine verknüpfte Qualifikation mit gleichem oder höherem Rang erfüllt auch Anforderungen an diese Qualifikation.

    • equivalent_qualificationsarray<EmploymentQualification>

      Verknüpfte ("gleichwertige") Qualifikationen. Vom Controller symmetrisch gehalten: jede Verknüpfung A->B wird als B->A gespiegelt; der Rang entscheidet, welche Richtung tatsächlich welche abdeckt.

    • qualification_groupEmploymentQualificationGroup

      L17/A06: die "Schublade", zu der diese Qualifikation gehört. Mitglieder einer Gruppe decken sich gegenseitig die Anforderungen innerhalb ihres Rangs ab, wie es eine direkte Verknüpfung täte.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • deletedboolean

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

    • namestring

      Name der Einheit.

  • qualification_match_modestring

    L18: EXACT verlangt die geforderte Qualifikation selbst; EQUIVALENT (Standard, bisheriges Verhalten) akzeptiert auch verknüpfte oder gleichgruppierte Qualifikationen mit ausreichendem Rang.

  • valid_fromstring (date-time)

    Regel gilt erst ab diesem Datum (null = immer).

  • valid_untilstring (date-time)

    Datum, bis zu dem die Anforderung gültig ist.

  • applies_on_holidaysboolean

    Ob die Regel auch an gesetzlichen Feiertagen des Kalenders ihres Geltungsbereichs gilt (Gruppenkalender, Organisationskalender, Hauptkalender). Standardmäßig aus: Eine geschlossene Kita oder ein geschlossenes Büro würde sonst an jedem Feiertag als unterbesetzt gemeldet; ein Verein oder eine Pflegeeinrichtung mit Feiertagsbetrieb schaltet sie ein.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • deletedboolean

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

  • namestring

    Name der Einheit.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/time/staffing_requirement/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "mode": "string",
    "weekdays_bitmask": 1,
    "start_time": "string",
    "end_time": "string",
    "min_staff_count": 1
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "employment_contract_group": {
    "id": 42,
    "name": "Beispiel",
    "staged_absence_approval": true,
    "shift_booking_sync": true,
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "year_vacation_days": 1.5,
    "month_vacation_days": 1.5,
    "year_vacation_weeks": 1.5,
    "monday_hours": 1.5
  },
  "employment_organization": {
    "id": 42,
    "name": "Beispiel",
    "staged_absence_approval": true,
    "allow_app_time_tracking": true,
    "school_holiday_region": {
      "id": 42,
      "name": "Beispiel",
      "region_code": "string",
      "sort_order": 1,
      "search_string": "string",
      "deleted": true,
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    },
    "organization_unit": {
      "id": 42,
      "name": "Beispiel",
      "path": "string",
      "depth": 1,
      "level": "string",
      "sort_order": 1,
      "search_string": "string",
      "deleted": true,
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00"
    },
    "shift_booking_sync": true,
    "allow_scanner_time_tracking": true,
    "allow_app_non_work_time_management": true,
    "include_in_auto_export": true
  },
  "organization_unit": {
    "id": 42,
    "name": "Beispiel",
    "path": "string",
    "depth": 1,
    "level": "string",
    "sort_order": 1,
    "search_string": "string",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "mode": "string",
  "weekdays_bitmask": 1,
  "start_time": "string",
  "end_time": "string",
  "min_staff_count": 1
}