Zum Inhalt springen
Developer

NonWorkTimePlanSelectionType

Personal5 EndpunkteTimeTracking / NonWorkTimePlanSelectionType

Diese Methode liefert alle NonWorkTimePlanSelectionType-Objekte

GET/api/time/non_work_time_plan_selection_type

Query-Parameter

idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE | Standardwert: false
namestring
valuestring
prioritystring
isVacationboolean
isSickboolean
selectableForRequestbooleanOb mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag – werden in den Editoren nicht angeboten. | Erforderliches Zugriffsrecht: SCOPE
statusChangeRequiresHrApprovalboolean
requiresManagementApprovalbooleanAnträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.
maxDaysPerRequeststringObergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt. | Erforderliches Zugriffsrecht: SCOPE
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 NonWorkTimePlanSelectionType-Objekte.array<NonWorkTimePlanSelectionType>

Felder anzeigen (16)
  • effective_colorstring

    Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

  • idinteger

    Primärschlüssel des Abwesenheitstyps. Interne ID.

  • namestring

    Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

  • valueinteger

    Numerischer Wert der Abwesenheitsart.

  • priorityinteger

    Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

  • processed_content_typestring

    Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

  • secondary_content_type_optionsstring

    Optionen für den sekundären Inhaltstyp, durch Komma getrennt

  • iconstring

    Symbol des Abwesenheitstyps.

  • is_vacationboolean

    Die Abwesenheitsart zählt als Urlaub.

  • is_sickboolean

    Die Abwesenheitsart zählt als Krankheit.

  • status_change_requires_hr_approvalboolean

    Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

  • selectable_for_requestboolean

    Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

  • requires_management_approvalboolean

    Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

  • max_days_per_requestinteger

    Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

  • colorstring

    R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

  • deletedboolean

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_plan_selection_type \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "effective_color": "#3f5efb",
    "id": 42,
    "name": "Beispiel",
    "color": "#3f5efb",
    "value": 1,
    "priority": 1,
    "processed_content_type": "string",
    "secondary_content_type_options": "string",
    "icon": "string",
    "is_vacation": true
  }
]

NonWorkTimePlanSelectionType neu anlegen

POST/api/time/non_work_time_plan_selection_type

Request-Body application/json

  • dataNonWorkTimePlanSelectionType2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200NonWorkTimePlanSelectionType neu anlegenNonWorkTimePlanSelectionType

Felder anzeigen (16)
  • effective_colorstring

    Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

  • idinteger

    Primärschlüssel des Abwesenheitstyps. Interne ID.

  • namestring

    Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

  • valueinteger

    Numerischer Wert der Abwesenheitsart.

  • priorityinteger

    Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

  • processed_content_typestring

    Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

  • secondary_content_type_optionsstring

    Optionen für den sekundären Inhaltstyp, durch Komma getrennt

  • iconstring

    Symbol des Abwesenheitstyps.

  • is_vacationboolean

    Die Abwesenheitsart zählt als Urlaub.

  • is_sickboolean

    Die Abwesenheitsart zählt als Krankheit.

  • status_change_requires_hr_approvalboolean

    Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

  • selectable_for_requestboolean

    Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

  • requires_management_approvalboolean

    Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

  • max_days_per_requestinteger

    Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

  • colorstring

    R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

  • deletedboolean

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

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_plan_selection_type \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "effective_color": "#3f5efb",
  "id": 42,
  "name": "Beispiel",
  "color": "#3f5efb",
  "value": 1,
  "priority": 1,
  "processed_content_type": "string",
  "secondary_content_type_options": "string",
  "icon": "string",
  "is_vacation": true
}

Diese Methode liefert einen einzelnen NonWorkTimePlanSelectionType mit der angegebenen ID

GET/api/time/non_work_time_plan_selection_type/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert ein einzelnes NonWorkTimePlanSelectionType-Objekt.NonWorkTimePlanSelectionType

Felder anzeigen (16)
  • effective_colorstring

    Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

  • idinteger

    Primärschlüssel des Abwesenheitstyps. Interne ID.

  • namestring

    Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

  • valueinteger

    Numerischer Wert der Abwesenheitsart.

  • priorityinteger

    Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

  • processed_content_typestring

    Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

  • secondary_content_type_optionsstring

    Optionen für den sekundären Inhaltstyp, durch Komma getrennt

  • iconstring

    Symbol des Abwesenheitstyps.

  • is_vacationboolean

    Die Abwesenheitsart zählt als Urlaub.

  • is_sickboolean

    Die Abwesenheitsart zählt als Krankheit.

  • status_change_requires_hr_approvalboolean

    Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

  • selectable_for_requestboolean

    Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

  • requires_management_approvalboolean

    Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

  • max_days_per_requestinteger

    Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

  • colorstring

    R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

  • deletedboolean

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_plan_selection_type/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "effective_color": "#3f5efb",
  "id": 42,
  "name": "Beispiel",
  "color": "#3f5efb",
  "value": 1,
  "priority": 1,
  "processed_content_type": "string",
  "secondary_content_type_options": "string",
  "icon": "string",
  "is_vacation": true
}

NonWorkTimePlanSelectionType aktualisieren

PUT/api/time/non_work_time_plan_selection_type/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataNonWorkTimePlanSelectionType2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200NonWorkTimePlanSelectionType aktualisierenNonWorkTimePlanSelectionType

Felder anzeigen (16)
  • effective_colorstring

    Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

  • idinteger

    Primärschlüssel des Abwesenheitstyps. Interne ID.

  • namestring

    Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

  • valueinteger

    Numerischer Wert der Abwesenheitsart.

  • priorityinteger

    Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

  • processed_content_typestring

    Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

  • secondary_content_type_optionsstring

    Optionen für den sekundären Inhaltstyp, durch Komma getrennt

  • iconstring

    Symbol des Abwesenheitstyps.

  • is_vacationboolean

    Die Abwesenheitsart zählt als Urlaub.

  • is_sickboolean

    Die Abwesenheitsart zählt als Krankheit.

  • status_change_requires_hr_approvalboolean

    Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

  • selectable_for_requestboolean

    Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

  • requires_management_approvalboolean

    Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

  • max_days_per_requestinteger

    Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

  • colorstring

    R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

  • deletedboolean

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

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_plan_selection_type/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "effective_color": "#3f5efb",
  "id": 42,
  "name": "Beispiel",
  "color": "#3f5efb",
  "value": 1,
  "priority": 1,
  "processed_content_type": "string",
  "secondary_content_type_options": "string",
  "icon": "string",
  "is_vacation": true
}

NonWorkTimePlanSelectionType aktualisieren

PATCH/api/time/non_work_time_plan_selection_type/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataNonWorkTimePlanSelectionType2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200NonWorkTimePlanSelectionType aktualisierenNonWorkTimePlanSelectionType

Felder anzeigen (16)
  • effective_colorstring

    Die anzuzeigende Farbe: die konfigurierte, sonst die Standardfarbe des Typs.

  • idinteger

    Primärschlüssel des Abwesenheitstyps. Interne ID.

  • namestring

    Name der Abwesenheitsart, zum Beispiel Urlaub oder Krankheit.

  • valueinteger

    Numerischer Wert der Abwesenheitsart.

  • priorityinteger

    Priorität des Abwesenheitstyps, wenn sich mehrere Typen überschneiden.

  • processed_content_typestring

    Inhaltstyp, der bei der Bearbeitung der Abwesenheit verwendet wird.

  • secondary_content_type_optionsstring

    Optionen für den sekundären Inhaltstyp, durch Komma getrennt

  • iconstring

    Symbol des Abwesenheitstyps.

  • is_vacationboolean

    Die Abwesenheitsart zählt als Urlaub.

  • is_sickboolean

    Die Abwesenheitsart zählt als Krankheit.

  • status_change_requires_hr_approvalboolean

    Die Änderung des Status dieses Abwesenheitstyps erfordert eine HR-Genehmigung.

  • selectable_for_requestboolean

    Ob mit diesem Typ eine neue Abwesenheitsanfrage angelegt werden darf. Typen, die nur einen Tag in einer Übersicht beschreiben – Feiertag, Schulferien, Arbeitstag –, werden in den Editoren nicht angeboten.

  • requires_management_approvalboolean

    Anträge dieses Typs benötigen eine abschließende schriftliche Entscheidung der Geschäftsführung (der Organisationsleitung), die nach der regulären Genehmigungskette (U10) angehängt wird.

  • max_days_per_requestinteger

    Obergrenze der Kalendertage, die eine Anfrage dieses Typs umfassen darf; null = unbegrenzt.

  • colorstring

    R5: Farbe dieses Abwesenheitstyps im Schichtplan und im Teamkalender ("#RRGGBB"); null = der Standardwert des Typs (getEffectiveColor). Wird mit absence_type_colors_enabled verwendet.

  • deletedboolean

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

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/time/non_work_time_plan_selection_type/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "effective_color": "#3f5efb",
  "id": 42,
  "name": "Beispiel",
  "color": "#3f5efb",
  "value": 1,
  "priority": 1,
  "processed_content_type": "string",
  "secondary_content_type_options": "string",
  "icon": "string",
  "is_vacation": true
}