SchoolHolidayRegion

Staff5 EndpointsTimeTracking / SchoolHolidayRegion

This method will get all SchoolHolidayRegion Objects

GET/api/time/school_holiday_region

Query parameters

`id`integer
`deleted`boolean	This property is used to mark an entity as deleted / archived \| Default value: false
`name`string
`regionCode`string	Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.
`sortOrder`integer	Order in pickers.
`created`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of SchoolHolidayRegion objectsarray<SchoolHolidayRegion>

Show fields (8)

idinteger
Primary key of the school holiday region. Internal ID.
region_codestring
Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.
sort_orderinteger
Order in pickers.
search_stringstring
Text that the entity can be searched by.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/time/school_holiday_region \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://your-instance.iw-erp.de/api/time/school_holiday_region', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/school_holiday_region"

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://your-instance.iw-erp.de/api/time/school_holiday_region', [
  '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://your-instance.iw-erp.de/api/time/school_holiday_region"),
  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://your-instance.iw-erp.de/api/time/school_holiday_region")
  .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://your-instance.iw-erp.de/api/time/school_holiday_region"

	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 with the iw_erp_api package

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

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

final result = await SchoolHolidayRegionController.getAll();
if (result.success) {
  print(result.data);
}

Response 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"
  }
]

Add a new SchoolHolidayRegion

POST/api/time/school_holiday_region

Request body application/json

dataSchoolHolidayRegion2
Show fields (4)
- region_codestring
  Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.
- sort_orderinteger
  Order in pickers.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.

Responses

200Add a new SchoolHolidayRegionSchoolHolidayRegion

Show fields (8)

idinteger
Primary key of the school holiday region. Internal ID.
region_codestring
Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.
sort_orderinteger
Order in pickers.
search_stringstring
Text that the entity can be searched by.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request POST \
  --url https://your-instance.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
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({data: {name: 'Beispiel', region_code: 'string', sort_order: 1, deleted: true}})
};

fetch('https://your-instance.iw-erp.de/api/time/school_holiday_region', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/school_holiday_region"

payload = { "data": {
    "name": "Beispiel",
    "region_code": "string",
    "sort_order": 1,
    "deleted": True
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/time/school_holiday_region', [
  'body' => '{"data":{"name":"Beispiel","region_code":"string","sort_order":1,"deleted":true}}',
  '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.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/school_holiday_region"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"name\":\"Beispiel\",\"region_code\":\"string\",\"sort_order\":1,\"deleted\":true}}")
  {
    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, "{\"data\":{\"name\":\"Beispiel\",\"region_code\":\"string\",\"sort_order\":1,\"deleted\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/school_holiday_region")
  .post(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://your-instance.iw-erp.de/api/time/school_holiday_region"

	payload := strings.NewReader("{\"data\":{\"name\":\"Beispiel\",\"region_code\":\"string\",\"sort_order\":1,\"deleted\":true}}")

	req, _ := http.NewRequest("POST", 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 with the iw_erp_api package

import 'package:iw_erp_api/clients/school_holiday_region_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/school_holiday_region.dart';

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

final result = await SchoolHolidayRegionController.post(SchoolHolidayRegion.fromJson({
  "name": "Beispiel",
  "region_code": "string",
  "sort_order": 1,
  "deleted": true
}));
if (result.success) {
  print(result.data);
}

Response 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"
}

This method will get a single SchoolHolidayRegion with the given id

GET/api/time/school_holiday_region/{id}

Path parameters

idrequiredstring

Responses

200Returns a single SchoolHolidayRegionSchoolHolidayRegion

Show fields (8)

idinteger
Primary key of the school holiday region. Internal ID.
region_codestring
Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.
sort_orderinteger
Order in pickers.
search_stringstring
Text that the entity can be searched by.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/time/school_holiday_region/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

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

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

import requests

url = "https://your-instance.iw-erp.de/api/time/school_holiday_region/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://your-instance.iw-erp.de/api/time/school_holiday_region/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://your-instance.iw-erp.de/api/time/school_holiday_region/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://your-instance.iw-erp.de/api/time/school_holiday_region/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://your-instance.iw-erp.de/api/time/school_holiday_region/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 with the iw_erp_api package

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

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

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

Response 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"
}

Update a SchoolHolidayRegion

PUT/api/time/school_holiday_region/{id}

Path parameters

idrequiredstring

Request body application/json

dataSchoolHolidayRegion2
Show fields (4)
- region_codestring
  Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.
- sort_orderinteger
  Order in pickers.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.

Responses

200Update a SchoolHolidayRegionSchoolHolidayRegion

Show fields (8)

idinteger
Primary key of the school holiday region. Internal ID.
region_codestring
Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.
sort_orderinteger
Order in pickers.
search_stringstring
Text that the entity can be searched by.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request PUT \
  --url https://your-instance.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
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({data: {name: 'Beispiel', region_code: 'string', sort_order: 1, deleted: true}})
};

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

import requests

url = "https://your-instance.iw-erp.de/api/time/school_holiday_region/42"

payload = { "data": {
    "name": "Beispiel",
    "region_code": "string",
    "sort_order": 1,
    "deleted": True
  } }
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://your-instance.iw-erp.de/api/time/school_holiday_region/42', [
  'body' => '{"data":{"name":"Beispiel","region_code":"string","sort_order":1,"deleted":true}}',
  '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://your-instance.iw-erp.de/api/time/school_holiday_region/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"name\":\"Beispiel\",\"region_code\":\"string\",\"sort_order\":1,\"deleted\":true}}")
  {
    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, "{\"data\":{\"name\":\"Beispiel\",\"region_code\":\"string\",\"sort_order\":1,\"deleted\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/school_holiday_region/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://your-instance.iw-erp.de/api/time/school_holiday_region/42"

	payload := strings.NewReader("{\"data\":{\"name\":\"Beispiel\",\"region_code\":\"string\",\"sort_order\":1,\"deleted\":true}}")

	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 with the iw_erp_api package

import 'package:iw_erp_api/clients/school_holiday_region_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/school_holiday_region.dart';

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

final result = await SchoolHolidayRegionController.put(SchoolHolidayRegion.fromJson({
  "name": "Beispiel",
  "region_code": "string",
  "sort_order": 1,
  "deleted": true
}));
if (result.success) {
  print(result.data);
}

Response 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"
}

Update a SchoolHolidayRegion

PATCH/api/time/school_holiday_region/{id}

Path parameters

idrequiredstring

Request body application/json

dataSchoolHolidayRegion2
Show fields (4)
- region_codestring
  Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.
- sort_orderinteger
  Order in pickers.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.

Responses

200Update a SchoolHolidayRegionSchoolHolidayRegion

Show fields (8)

idinteger
Primary key of the school holiday region. Internal ID.
region_codestring
Short code, e.g. the Bundesland code (NI, HH, ...). Optional, for pickers and imports.
sort_orderinteger
Order in pickers.
search_stringstring
Text that the entity can be searched by.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request PATCH \
  --url https://your-instance.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
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({data: {name: 'Beispiel', region_code: 'string', sort_order: 1, deleted: true}})
};

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

import requests

url = "https://your-instance.iw-erp.de/api/time/school_holiday_region/42"

payload = { "data": {
    "name": "Beispiel",
    "region_code": "string",
    "sort_order": 1,
    "deleted": True
  } }
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://your-instance.iw-erp.de/api/time/school_holiday_region/42', [
  'body' => '{"data":{"name":"Beispiel","region_code":"string","sort_order":1,"deleted":true}}',
  '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://your-instance.iw-erp.de/api/time/school_holiday_region/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"name\":\"Beispiel\",\"region_code\":\"string\",\"sort_order\":1,\"deleted\":true}}")
  {
    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, "{\"data\":{\"name\":\"Beispiel\",\"region_code\":\"string\",\"sort_order\":1,\"deleted\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/school_holiday_region/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://your-instance.iw-erp.de/api/time/school_holiday_region/42"

	payload := strings.NewReader("{\"data\":{\"name\":\"Beispiel\",\"region_code\":\"string\",\"sort_order\":1,\"deleted\":true}}")

	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 with package:http (no controller in the iw_erp_api package)

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

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/time/school_holiday_region/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "name": "Beispiel",
      "region_code": "string",
      "sort_order": 1,
      "deleted": true
    }
  }),
);
print(response.body);

Response 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"
}