Zum Inhalt springen
Developer

SchoolHolidayRegion

Personal5 EndpunkteTimeTracking / SchoolHolidayRegion

Diese Methode liefert alle SchoolHolidayRegion-Objekte

GET/api/time/school_holiday_region

Query-Parameter

idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE | Standardwert: false
namestring
regionCodestringKurzcode, zum Beispiel der Bundesland-Code (NI, HH, ...). Optional, für Auswahllisten und Importe.
sortOrderintegerReihenfolge in Auswahllisten.
createdstring
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

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

Felder anzeigen (8)
  • idinteger

    Primärschlüssel der Schulferienregion. Interne ID.

  • region_codestring

    Kurzcode, zum Beispiel der Bundesland-Code (NI, HH, ...). Optional, für Auswahllisten und Importe.

  • sort_orderinteger

    Reihenfolge in Auswahllisten.

  • 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/school_holiday_region \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "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"
  }
]

SchoolHolidayRegion neu anlegen

POST/api/time/school_holiday_region

Request-Body application/json

  • dataSchoolHolidayRegion2
    Felder anzeigen (4)
    • region_codestring

      Kurzcode, zum Beispiel der Bundesland-Code (NI, HH, ...). Optional, für Auswahllisten und Importe.

    • sort_orderinteger

      Reihenfolge in Auswahllisten.

    • deletedboolean

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

    • namestring

      Name der Einheit.

Antworten

200SchoolHolidayRegion neu anlegenSchoolHolidayRegion

Felder anzeigen (8)
  • idinteger

    Primärschlüssel der Schulferienregion. Interne ID.

  • region_codestring

    Kurzcode, zum Beispiel der Bundesland-Code (NI, HH, ...). Optional, für Auswahllisten und Importe.

  • sort_orderinteger

    Reihenfolge in Auswahllisten.

  • 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/school_holiday_region \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "region_code": "string",
    "sort_order": 1,
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "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"
}

Diese Methode liefert eine einzelne SchoolHolidayRegion mit der angegebenen ID

GET/api/time/school_holiday_region/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert ein einzelnes SchoolHolidayRegion-Objekt.SchoolHolidayRegion

Felder anzeigen (8)
  • idinteger

    Primärschlüssel der Schulferienregion. Interne ID.

  • region_codestring

    Kurzcode, zum Beispiel der Bundesland-Code (NI, HH, ...). Optional, für Auswahllisten und Importe.

  • sort_orderinteger

    Reihenfolge in Auswahllisten.

  • 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/school_holiday_region/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "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"
}

SchoolHolidayRegion aktualisieren

PUT/api/time/school_holiday_region/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataSchoolHolidayRegion2
    Felder anzeigen (4)
    • region_codestring

      Kurzcode, zum Beispiel der Bundesland-Code (NI, HH, ...). Optional, für Auswahllisten und Importe.

    • sort_orderinteger

      Reihenfolge in Auswahllisten.

    • deletedboolean

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

    • namestring

      Name der Einheit.

Antworten

200SchoolHolidayRegion aktualisierenSchoolHolidayRegion

Felder anzeigen (8)
  • idinteger

    Primärschlüssel der Schulferienregion. Interne ID.

  • region_codestring

    Kurzcode, zum Beispiel der Bundesland-Code (NI, HH, ...). Optional, für Auswahllisten und Importe.

  • sort_orderinteger

    Reihenfolge in Auswahllisten.

  • 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/school_holiday_region/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "region_code": "string",
    "sort_order": 1,
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "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"
}

SchoolHolidayRegion aktualisieren

PATCH/api/time/school_holiday_region/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataSchoolHolidayRegion2
    Felder anzeigen (4)
    • region_codestring

      Kurzcode, zum Beispiel der Bundesland-Code (NI, HH, ...). Optional, für Auswahllisten und Importe.

    • sort_orderinteger

      Reihenfolge in Auswahllisten.

    • deletedboolean

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

    • namestring

      Name der Einheit.

Antworten

200SchoolHolidayRegion aktualisierenSchoolHolidayRegion

Felder anzeigen (8)
  • idinteger

    Primärschlüssel der Schulferienregion. Interne ID.

  • region_codestring

    Kurzcode, zum Beispiel der Bundesland-Code (NI, HH, ...). Optional, für Auswahllisten und Importe.

  • sort_orderinteger

    Reihenfolge in Auswahllisten.

  • 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/school_holiday_region/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "region_code": "string",
    "sort_order": 1,
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "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"
}