Calendar

OpenData / Kalender

Offene Daten6 EndpunkteOpenData / Calendar

Alle fehlenden Kalendereinträge des angegebenen Jahres anlegen

POST/api/opendata/calendar_generate/{entityType}/{year}

Wird von der Oberfläche genutzt, um einen leeren Kalender zu füllen. Das angeforderte Jahr wird direkt angelegt, damit der Benutzer das Ergebnis sofort sieht; die übrigen Jahre legt der Hintergrundbefehl an.

Pfad-Parameter

`entityType`Pflichtstring
`year`Pflichtstring

Antworten

200Erstellt die fehlenden Kalendertage und liefert eine kurze Zusammenfassung zurück

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/opendata/calendar_generate/42/42

const options = {method: 'POST'};

fetch('https://eure-instanz.iw-erp.de/api/opendata/calendar_generate/42/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/opendata/calendar_generate/42/42"

response = requests.post(url)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/opendata/calendar_generate/42/42');

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/opendata/calendar_generate/42/42"),
};
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/opendata/calendar_generate/42/42")
  .post(null)
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/opendata/calendar_generate/42/42"

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

	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/sys_calendar_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';

final result = await SysCalendarController.generate('42', '42');
if (result.success) {
  print(result.data);
}

Liefert eine Liste der Regionen, die für den Import der Feiertagseinträge ausgewählt werden können.

GET/api/opendata/calendar_holiday_regions

Antworten

200Liefert die auswählbaren Feiertagsregionen

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/opendata/calendar_holiday_regions

const options = {method: 'GET'};

fetch('https://eure-instanz.iw-erp.de/api/opendata/calendar_holiday_regions', 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/opendata/calendar_holiday_regions"

response = requests.get(url)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/opendata/calendar_holiday_regions');

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/opendata/calendar_holiday_regions"),
};
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/opendata/calendar_holiday_regions")
  .get()
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/opendata/calendar_holiday_regions"

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

	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/sys_calendar_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';

final result = await SysCalendarController.getHolidayRegions();
if (result.success) {
  print(result.data);
}

Die gesetzlichen Feiertage des angegebenen Jahres und der Region in den Kalender importieren

POST/api/opendata/calendar_holiday_import/{entityType}/{year}

Die Arbeitszeiteinstellungen und – für den Hauptkalender – die Termineinstellungen, die auf jeden Feiertag angewendet werden sollen, sind Teil der Anfrage.

Pfad-Parameter

`entityType`Pflichtstring
`year`Pflichtstring

Antworten

200Importiert die gesetzlichen Feiertage und gibt die geänderten Tage zurück

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/opendata/calendar_holiday_import/42/42

const options = {method: 'POST'};

fetch('https://eure-instanz.iw-erp.de/api/opendata/calendar_holiday_import/42/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/opendata/calendar_holiday_import/42/42"

response = requests.post(url)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/opendata/calendar_holiday_import/42/42');

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/opendata/calendar_holiday_import/42/42"),
};
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/opendata/calendar_holiday_import/42/42")
  .post(null)
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/opendata/calendar_holiday_import/42/42"

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

	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/sys_calendar_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';

final result = await SysCalendarController.importHolidays('42', '42', region: '…');
if (result.success) {
  print(result.data);
}

Legt die Arbeitszeit-Kennzeichen jedes Tages in einem Datumsbereich fest (U09: Schulferienzeiträume)

POST/api/opendata/calendar_range/{entityType}

Fehlende Tage werden angelegt. Tage, die bereits Kennzeichen tragen, werden nur ersetzt, wenn overwrite true ist (Vorgabe). clear = true entfernt stattdessen die Kennzeichen des Zeitraums.

Pfad-Parameter

entityTypePflichtstring

Antworten

200Aktualisiert die Tage des Zeitraums und gibt eine kurze Zusammenfassung zurück

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42

const options = {method: 'POST'};

fetch('https://eure-instanz.iw-erp.de/api/opendata/calendar_range/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/opendata/calendar_range/42"

response = requests.post(url)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42');

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42"),
};
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/opendata/calendar_range/42")
  .post(null)
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42"

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

	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/sys_calendar_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';

final result = await SysCalendarController.updateRange('42', from: '…', to: '…');
if (result.success) {
  print(result.data);
}

Legt die Arbeitszeit-Kennzeichen jedes Tages in einem Datumsbereich fest (U09: Schulferienzeiträume)

PUT/api/opendata/calendar_range/{entityType}

Fehlende Tage werden angelegt. Tage, die bereits Kennzeichen tragen, werden nur ersetzt, wenn overwrite true ist (Vorgabe). clear = true entfernt stattdessen die Kennzeichen des Zeitraums.

Pfad-Parameter

entityTypePflichtstring

Antworten

200Aktualisiert die Tage des Zeitraums und gibt eine kurze Zusammenfassung zurück

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42

const options = {method: 'PUT'};

fetch('https://eure-instanz.iw-erp.de/api/opendata/calendar_range/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/opendata/calendar_range/42"

response = requests.put(url)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42');

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/opendata/calendar_range/42"),
};
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/opendata/calendar_range/42")
  .put(null)
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42"

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

	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 'package:http/http.dart' as http;

final response = await http.put(
  Uri.parse('https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42'),
  headers: {},
);
print(response.body);

Legt die Arbeitszeit-Kennzeichen jedes Tages in einem Datumsbereich fest (U09: Schulferienzeiträume)

PATCH/api/opendata/calendar_range/{entityType}

Fehlende Tage werden angelegt. Tage, die bereits Kennzeichen tragen, werden nur ersetzt, wenn overwrite true ist (Vorgabe). clear = true entfernt stattdessen die Kennzeichen des Zeitraums.

Pfad-Parameter

entityTypePflichtstring

Antworten

200Aktualisiert die Tage des Zeitraums und gibt eine kurze Zusammenfassung zurück

Anfrage

curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42

const options = {method: 'PATCH'};

fetch('https://eure-instanz.iw-erp.de/api/opendata/calendar_range/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/opendata/calendar_range/42"

response = requests.patch(url)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42');

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/opendata/calendar_range/42"),
};
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/opendata/calendar_range/42")
  .patch(null)
  .build();

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

package main

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

func main() {

	url := "https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42"

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

	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 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://eure-instanz.iw-erp.de/api/opendata/calendar_range/42'),
  headers: {},
);
print(response.body);