StaffingCoverageAlarm

Personal4 EndpunkteTimeTracking / StaffingCoverageAlarm

Einzelnen StaffingCoverageAlarm abrufen

GET/api/time/staffing_coverage_alarm/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert ein einzelnes StaffingCoverageAlarm-Objekt.StaffingCoverageAlarm

Felder anzeigen (14)

statusstring
idinteger
Primärschlüssel des Besetzungsalarms. Interne ID.
requirementStaffingRequirement4
Nicht abgedeckter Personalbedarf.
Felder anzeigen (21)
- idinteger
  Primärschlüssel des Besetzungsbedarfs. Interne ID.
- employment_contract_groupEmploymentContractGroup
  Vertragsgruppe, für die die Anforderung gilt.
- employment_organizationEmploymentOrganization6
  Organisation, auf die sich die Anforderung bezieht.
- organization_unitOrganizationUnit6
  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.
- 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_qualificationEmploymentQualification8
  Optionale Qualifikation, die die gezählten Personen erfüllen müssen (Gleichwertigkeiten und Rangfolge werden vom QualificationMatchHelper berücksichtigt).
- 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.
datestring (date-time)
Datum des Alarms.
required_countinteger
Anzahl der benötigten Mitarbeitenden.
covered_countinteger
Anzahl der verfügbaren Mitarbeitenden.
sourcestring
WORKER (täglicher Scan) oder APPROVAL (eine Genehmigung hat den Tag unter das Minimum gesenkt).
requestNonWorkTimeRequest4
Der Antrag, dessen Genehmigung den Alarm ausgelöst hat, sofern es einer war (L54).
Felder anzeigen (35)
- overdueboolean
  U04: noch offen nach Ablauf der Bearbeitungsfrist.
- approval_versioninteger
  Version des Genehmigungsprozesses.
- change_modestring
  Art der Änderung an der Anfrage.
- balance_override_reasonstring
  L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.
- coverage_override_reasonstring
  L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.
- coverage_hintboolean
  L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.
- sick_during_vacationboolean
  U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".
- consultation_notestring
  Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.
- daily_absence_start_timestring
  Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.
- daily_absence_end_timestring
  Endzeit der ganztägigen Abwesenheit.
- idinteger
  Primärschlüssel der Anfrage. Interne ID.
- userUser14
  Benutzer, zu dem die Anfrage gehört.
- descriptionstring
  Beschreibung des Antrags.
- startstring (date-time)
  Beginn des angefragten Zeitraums.
- start_datestring
  Startdatum des angefragten Zeitraums.
- start_monthinteger
  Startmonat des angefragten Zeitraums.
- start_yearinteger
  Startjahr des angefragten Zeitraums.
- endstring (date-time)
  Ende des angeforderten Zeitraums.
- end_datestring
  Enddatum des angeforderten Zeitraums.
- end_monthinteger
  Endmonat des angeforderten Zeitraums.
- end_yearinteger
  Endjahr des angeforderten Zeitraums.
- durationnumber (float)
  Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)
- statusstring
  Status der Anfrage.
- content_typestring
  Art des Antrags, z. B. Urlaub oder Abwesenheit.
- secondary_content_typestring
  Sekundärer Typ der Anfrage.
- linked_content_typeNonWorkTimePlanSelectionType3
  Mit der Anfrage verknüpfter Planauswahltyp.
- parent_requestNonWorkTimeRequest4
  Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.
- annual_requestNonWorkTimeAnnualRequest7
  L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.
- request_kindstring
  U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.
- processing_due_datestring (date-time)
  U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.
- escalated_atstring (date-time)
  U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.
- written_approval_reasonstring
  U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
notified_atstring (date-time)
Zeitpunkt, zu dem der Alarm gesendet wurde.
resolved_atstring (date-time)
Zeitpunkt, zu dem der Alarm aufgelöst wurde.
acknowledged_atstring (date-time)
Zeitpunkt, zu dem der Alarm bestätigt wurde.
acknowledged_by_userUser14
Benutzer, der den Alarm bestätigt hat.
Felder anzeigen (10)
- idinteger
  Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.
- namestring
  Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.
- usernamestring
  Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.
- emailstring
  E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.
- positioningeneralstring
  Freitext zur Position oder Rolle des Benutzers.
- crm_personCRMPerson10
  CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.
- profile_picture_urlstring
  URL des Profilbilds des Benutzers.
- archivedboolean
  Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.
- require2faboolean
  Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
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_coverage_alarm/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/staffing_coverage_alarm_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await StaffingCoverageAlarmController.get('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "status": "string",
  "requirement": {
    "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
  },
  "date": "2026-10-15T09:30:00+02:00",
  "required_count": 1,
  "covered_count": 1,
  "source": "string",
  "request": {
    "id": 42,
    "description": "Text",
    "overdue": true,
    "approval_version": 1,
    "change_mode": "string",
    "balance_override_reason": "string",
    "coverage_override_reason": "string",
    "coverage_hint": true,
    "sick_during_vacation": true,
    "consultation_note": "string"
  },
  "notified_at": "2026-10-15T09:30:00+02:00",
  "resolved_at": "2026-10-15T09:30:00+02:00"
}

Alarm bestätigen (die Verwaltung hat ihn gesehen und kümmert sich darum)

PUT/api/time/staffing_coverage_alarm/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

dataStaffingCoverageAlarm2

Antworten

200StaffingCoverageAlarm bestätigenStaffingCoverageAlarm

Felder anzeigen (14)

statusstring
idinteger
Primärschlüssel des Besetzungsalarms. Interne ID.
requirementStaffingRequirement4
Nicht abgedeckter Personalbedarf.
Felder anzeigen (21)
- idinteger
  Primärschlüssel des Besetzungsbedarfs. Interne ID.
- employment_contract_groupEmploymentContractGroup
  Vertragsgruppe, für die die Anforderung gilt.
- employment_organizationEmploymentOrganization6
  Organisation, auf die sich die Anforderung bezieht.
- organization_unitOrganizationUnit6
  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.
- 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_qualificationEmploymentQualification8
  Optionale Qualifikation, die die gezählten Personen erfüllen müssen (Gleichwertigkeiten und Rangfolge werden vom QualificationMatchHelper berücksichtigt).
- 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.
datestring (date-time)
Datum des Alarms.
required_countinteger
Anzahl der benötigten Mitarbeitenden.
covered_countinteger
Anzahl der verfügbaren Mitarbeitenden.
sourcestring
WORKER (täglicher Scan) oder APPROVAL (eine Genehmigung hat den Tag unter das Minimum gesenkt).
requestNonWorkTimeRequest4
Der Antrag, dessen Genehmigung den Alarm ausgelöst hat, sofern es einer war (L54).
Felder anzeigen (35)
- overdueboolean
  U04: noch offen nach Ablauf der Bearbeitungsfrist.
- approval_versioninteger
  Version des Genehmigungsprozesses.
- change_modestring
  Art der Änderung an der Anfrage.
- balance_override_reasonstring
  L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.
- coverage_override_reasonstring
  L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.
- coverage_hintboolean
  L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.
- sick_during_vacationboolean
  U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".
- consultation_notestring
  Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.
- daily_absence_start_timestring
  Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.
- daily_absence_end_timestring
  Endzeit der ganztägigen Abwesenheit.
- idinteger
  Primärschlüssel der Anfrage. Interne ID.
- userUser14
  Benutzer, zu dem die Anfrage gehört.
- descriptionstring
  Beschreibung des Antrags.
- startstring (date-time)
  Beginn des angefragten Zeitraums.
- start_datestring
  Startdatum des angefragten Zeitraums.
- start_monthinteger
  Startmonat des angefragten Zeitraums.
- start_yearinteger
  Startjahr des angefragten Zeitraums.
- endstring (date-time)
  Ende des angeforderten Zeitraums.
- end_datestring
  Enddatum des angeforderten Zeitraums.
- end_monthinteger
  Endmonat des angeforderten Zeitraums.
- end_yearinteger
  Endjahr des angeforderten Zeitraums.
- durationnumber (float)
  Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)
- statusstring
  Status der Anfrage.
- content_typestring
  Art des Antrags, z. B. Urlaub oder Abwesenheit.
- secondary_content_typestring
  Sekundärer Typ der Anfrage.
- linked_content_typeNonWorkTimePlanSelectionType3
  Mit der Anfrage verknüpfter Planauswahltyp.
- parent_requestNonWorkTimeRequest4
  Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.
- annual_requestNonWorkTimeAnnualRequest7
  L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.
- request_kindstring
  U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.
- processing_due_datestring (date-time)
  U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.
- escalated_atstring (date-time)
  U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.
- written_approval_reasonstring
  U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
notified_atstring (date-time)
Zeitpunkt, zu dem der Alarm gesendet wurde.
resolved_atstring (date-time)
Zeitpunkt, zu dem der Alarm aufgelöst wurde.
acknowledged_atstring (date-time)
Zeitpunkt, zu dem der Alarm bestätigt wurde.
acknowledged_by_userUser14
Benutzer, der den Alarm bestätigt hat.
Felder anzeigen (10)
- idinteger
  Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.
- namestring
  Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.
- usernamestring
  Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.
- emailstring
  E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.
- positioningeneralstring
  Freitext zur Position oder Rolle des Benutzers.
- crm_personCRMPerson10
  CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.
- profile_picture_urlstring
  URL des Profilbilds des Benutzers.
- archivedboolean
  Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.
- require2faboolean
  Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
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_coverage_alarm/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42"

payload = {}
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42', [
  'body' => '{}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/staffing_coverage_alarm_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await StaffingCoverageAlarmController.acknowledge(42);
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "status": "string",
  "requirement": {
    "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
  },
  "date": "2026-10-15T09:30:00+02:00",
  "required_count": 1,
  "covered_count": 1,
  "source": "string",
  "request": {
    "id": 42,
    "description": "Text",
    "overdue": true,
    "approval_version": 1,
    "change_mode": "string",
    "balance_override_reason": "string",
    "coverage_override_reason": "string",
    "coverage_hint": true,
    "sick_during_vacation": true,
    "consultation_note": "string"
  },
  "notified_at": "2026-10-15T09:30:00+02:00",
  "resolved_at": "2026-10-15T09:30:00+02:00"
}

Alarm bestätigen (die Verwaltung hat ihn gesehen und kümmert sich darum)

PATCH/api/time/staffing_coverage_alarm/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

dataStaffingCoverageAlarm2

Antworten

200StaffingCoverageAlarm bestätigenStaffingCoverageAlarm

Felder anzeigen (14)

statusstring
idinteger
Primärschlüssel des Besetzungsalarms. Interne ID.
requirementStaffingRequirement4
Nicht abgedeckter Personalbedarf.
Felder anzeigen (21)
- idinteger
  Primärschlüssel des Besetzungsbedarfs. Interne ID.
- employment_contract_groupEmploymentContractGroup
  Vertragsgruppe, für die die Anforderung gilt.
- employment_organizationEmploymentOrganization6
  Organisation, auf die sich die Anforderung bezieht.
- organization_unitOrganizationUnit6
  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.
- 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_qualificationEmploymentQualification8
  Optionale Qualifikation, die die gezählten Personen erfüllen müssen (Gleichwertigkeiten und Rangfolge werden vom QualificationMatchHelper berücksichtigt).
- 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.
datestring (date-time)
Datum des Alarms.
required_countinteger
Anzahl der benötigten Mitarbeitenden.
covered_countinteger
Anzahl der verfügbaren Mitarbeitenden.
sourcestring
WORKER (täglicher Scan) oder APPROVAL (eine Genehmigung hat den Tag unter das Minimum gesenkt).
requestNonWorkTimeRequest4
Der Antrag, dessen Genehmigung den Alarm ausgelöst hat, sofern es einer war (L54).
Felder anzeigen (35)
- overdueboolean
  U04: noch offen nach Ablauf der Bearbeitungsfrist.
- approval_versioninteger
  Version des Genehmigungsprozesses.
- change_modestring
  Art der Änderung an der Anfrage.
- balance_override_reasonstring
  L11: warum ein Planer diesen Antrag genehmigt hat, obwohl der prognostizierte Urlaubssaldo negativ war.
- coverage_override_reasonstring
  L54: warum der Genehmiger einen Tag unter der Mindestbesetzung akzeptiert hat.
- coverage_hintboolean
  L53: eingereicht, obwohl er den Personalpuffer angreift - die Genehmiger sehen den Hinweis.
- sick_during_vacationboolean
  U13: eine Krankmeldung innerhalb genehmigten Urlaubs - vom Server gesetzt, angezeigt als "während Urlaub".
- consultation_notestring
  Wer vor der Anfrage von Tagen, die ein blockierender Zeitraum als nur mit Abstimmung markiert (U14), konsultiert wurde.
- daily_absence_start_timestring
  Lokales tägliches Abwesenheitsfenster für halbtägige Typen; null behält die bisherige Planung bei.
- daily_absence_end_timestring
  Endzeit der ganztägigen Abwesenheit.
- idinteger
  Primärschlüssel der Anfrage. Interne ID.
- userUser14
  Benutzer, zu dem die Anfrage gehört.
- descriptionstring
  Beschreibung des Antrags.
- startstring (date-time)
  Beginn des angefragten Zeitraums.
- start_datestring
  Startdatum des angefragten Zeitraums.
- start_monthinteger
  Startmonat des angefragten Zeitraums.
- start_yearinteger
  Startjahr des angefragten Zeitraums.
- endstring (date-time)
  Ende des angeforderten Zeitraums.
- end_datestring
  Enddatum des angeforderten Zeitraums.
- end_monthinteger
  Endmonat des angeforderten Zeitraums.
- end_yearinteger
  Endjahr des angeforderten Zeitraums.
- durationnumber (float)
  Dauer in Tagen, verknüpft mit NonWorkTimePlan – ein Halbtagstyp zählt 0,5 (Z6)
- statusstring
  Status der Anfrage.
- content_typestring
  Art des Antrags, z. B. Urlaub oder Abwesenheit.
- secondary_content_typestring
  Sekundärer Typ der Anfrage.
- linked_content_typeNonWorkTimePlanSelectionType3
  Mit der Anfrage verknüpfter Planauswahltyp.
- parent_requestNonWorkTimeRequest4
  Der Antrag, den dieser ändert („Änderungsantrag zum Jahresurlaub“). Ein Änderungsantrag ist in jeder anderen Hinsicht ein gewöhnlicher Antrag; die Referenz macht aus einem zweiten, unabhängig wirkenden Antrag eine sichtbare Korrektur des ersten – und sorgt dafür, dass die damit zurückgezogenen Tage als zurückgezogen statt nur als abgelehnt markiert werden.
- annual_requestNonWorkTimeAnnualRequest7
  L47/L48: der Jahresplan ("Jahresurlaubsantrag"), zu dem dieser Zeitraum gehört. Das Bündel wird als Ganzes entschieden; der Zeitraum bleibt in jeder anderen Hinsicht ein gewöhnlicher Antrag.
- request_kindstring
  U02/U18: ANNUAL = Zeitraum des Jahresplans, SUPPLEMENT = Ergänzungsantrag für die zurückgehaltenen flexiblen Tage. null = regulärer Antrag.
- processing_due_datestring (date-time)
  U04/U20: der Tag, bis zu dem über den Antrag entschieden werden muss, gerechnet ab Eingang.
- escalated_atstring (date-time)
  U04: Zeitpunkt, zu dem die Eskalation wegen Überfälligkeit gesendet wurde; null = noch nicht eskaliert.
- written_approval_reasonstring
  U21: warum dieser Antrag um den Schritt der Geschäftsführung mit schriftlichem Kommentar ergänzt wurde (z. B. SUMMER_CANCELLATION); null = keine zusätzliche schriftliche Genehmigung nötig.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
notified_atstring (date-time)
Zeitpunkt, zu dem der Alarm gesendet wurde.
resolved_atstring (date-time)
Zeitpunkt, zu dem der Alarm aufgelöst wurde.
acknowledged_atstring (date-time)
Zeitpunkt, zu dem der Alarm bestätigt wurde.
acknowledged_by_userUser14
Benutzer, der den Alarm bestätigt hat.
Felder anzeigen (10)
- idinteger
  Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.
- namestring
  Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.
- usernamestring
  Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.
- emailstring
  E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.
- positioningeneralstring
  Freitext zur Position oder Rolle des Benutzers.
- crm_personCRMPerson10
  CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.
- profile_picture_urlstring
  URL des Profilbilds des Benutzers.
- archivedboolean
  Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.
- require2faboolean
  Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
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_coverage_alarm/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42"

payload = {}
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42', [
  'body' => '{}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit package:http (kein Controller im Package iw_erp_api)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://eure-instanz.iw-erp.de/api/time/staffing_coverage_alarm/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({}),
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "status": "string",
  "requirement": {
    "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
  },
  "date": "2026-10-15T09:30:00+02:00",
  "required_count": 1,
  "covered_count": 1,
  "source": "string",
  "request": {
    "id": 42,
    "description": "Text",
    "overdue": true,
    "approval_version": 1,
    "change_mode": "string",
    "balance_override_reason": "string",
    "coverage_override_reason": "string",
    "coverage_hint": true,
    "sick_during_vacation": true,
    "consultation_note": "string"
  },
  "notified_at": "2026-10-15T09:30:00+02:00",
  "resolved_at": "2026-10-15T09:30:00+02:00"
}