EmployeeDocument

Personal14 EndpunkteTimeTracking / EmployeeDocument

Alle EmployeeDocument abrufen

GET/api/employee_documents/document

Query-Parameter

`id`integer
`token`string
`title`string
`documentType`string
`category`string
`status`string
`requiresAcknowledgment`boolean
`requiresSignature`boolean
`requiresFormFilling`boolean
`targetAllEmployees`boolean
`dueDate`string
`publishedAt`string
`createdByUser`string
`createdByPerson`string
`created`string
`updated`string
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Alle EmployeeDocument abrufenarray<EmployeeDocument>

Felder anzeigen (18)

idinteger
Primärschlüssel des Mitarbeiterdokuments. Interne ID.
tokenstring
Öffentlicher Token des Dokuments. Anstelle der ID verwendet.
titlestring
Titel des Dokuments.
descriptionstring
Beschreibung des Dokuments.
document_typestring
Art des Dokuments, zum Beispiel Vertrag oder Bescheid.
categorystring
Kategorie des Dokuments.
statusstring
Status des Dokuments, zum Beispiel Entwurf oder veröffentlicht.
requires_acknowledgmentboolean
Mitarbeitende müssen das Dokument bestätigen.
requires_signatureboolean
Mitarbeitende müssen das Dokument unterschreiben.
requires_form_fillingboolean
Mitarbeitende müssen ein Formular ausfüllen.
target_all_employeesboolean
Das Dokument gilt für alle Mitarbeitenden.
due_datestring (date-time)
Datum, bis zu dem die Antwort fällig ist.
published_atstring (date-time)
Zeitpunkt, zu dem das Dokument veröffentlicht wurde.
attachmentAttachment10
Datei, die dem Dokument beigefügt ist.
Felder anzeigen (25)
- idinteger
  Primärschlüssel des Anhangs. Interne ID.
- filenamestring
  Ursprünglicher Dateiname.
- filesizestring
  Größe der Datei in Bytes.
- mimetypestring
  MIME-Typ der Datei.
- createdbyusernamestring
  Name des Benutzers, der die Datei hochgeladen hat, als Text.
- createdstring (date-time)
  Zeitpunkt, zu dem der Anhang angelegt wurde.
- googleidstring
  ID der Datei in Google Drive.
- scopestring
  Scope, der steuert, wer den Anhang sehen kann.
- ocr_document_typestring
  Dokumenttyp, der per OCR erkannt wurde.
- ocr_from_namestring
  Per OCR erkannter Absendername.
- ocr_from_companystring
  Per OCR erkanntes Absenderunternehmen.
- ocr_from_addressstring
  Per OCR erkannte Absenderadresse.
- ocr_from_emailstring
  Per OCR erkannte Absender-E-Mail-Adresse.
- ocr_from_phonestring
  Per OCR erkannte Absender-Telefonnummer.
- ocr_to_namestring
  Per OCR erkannter Name des Empfängers.
- ocr_to_companystring
  Per OCR erkanntes Empfängerunternehmen.
- ocr_to_addressstring
  Per OCR erkannte Empfängeradresse.
- ocr_to_emailstring
  Per OCR erkannte E-Mail-Adresse des Empfängers.
- ocr_to_phonestring
  Per OCR erkannte Telefonnummer des Empfängers.
- ocr_summarystring
  Zusammenfassung des per OCR erstellten Dokuments.
- ocr_statusstring
  OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error
- ocr_errorstring
  Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war
- ocr_processed_atstring (date-time)
  Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.
- virus_checkedboolean
  1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.
- virus_checked_atstring (date-time)
  Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.
created_by_userUser14
Benutzer, der das Dokument erstellt 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.
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/employee_documents/document \
  --header 'x-iw-jwt-token: <TOKEN>'

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

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

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/employee_documents/document', [
  '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/employee_documents/document"),
  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/employee_documents/document")
  .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/employee_documents/document"

	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/time_tracking_employee_document_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 TimeTrackingEmployeeDocumentController.getAll();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "title": "Beispiel",
    "description": "Text",
    "token": "string",
    "document_type": "string",
    "category": "string",
    "status": "string",
    "requires_acknowledgment": true,
    "requires_signature": true,
    "requires_form_filling": true
  }
]

Einzelnen EmployeeDocument anlegen (Entwurf)

POST/api/employee_documents/document

Request-Body application/json

dataEmployeeDocument2
Felder anzeigen (13)
- titlestring
  Titel des Dokuments.
- descriptionstring
  Beschreibung des Dokuments.
- document_typestring
  Art des Dokuments, zum Beispiel Vertrag oder Bescheid.
- categorystring
  Kategorie des Dokuments.
- statusstring
  Status des Dokuments, zum Beispiel Entwurf oder veröffentlicht.
- requires_acknowledgmentboolean
  Mitarbeitende müssen das Dokument bestätigen.
- requires_signatureboolean
  Mitarbeitende müssen das Dokument unterschreiben.
- requires_form_fillingboolean
  Mitarbeitende müssen ein Formular ausfüllen.
- target_all_employeesboolean
  Das Dokument gilt für alle Mitarbeitenden.
- due_datestring (date-time)
  Datum, bis zu dem die Antwort fällig ist.
- target_employeesarray<CRMPerson41>
- target_contract_groupsarray<EmploymentContractGroup5>
- target_organizationsarray<EmploymentOrganization3>

Antworten

200Einzelnen EmployeeDocument anlegenEmployeeDocument3

Felder anzeigen (18)

idinteger
Primärschlüssel des Mitarbeiterdokuments. Interne ID.
tokenstring
Öffentlicher Token des Dokuments. Anstelle der ID verwendet.
titlestring
Titel des Dokuments.
descriptionstring
Beschreibung des Dokuments.
document_typestring
Art des Dokuments, zum Beispiel Vertrag oder Bescheid.
categorystring
Kategorie des Dokuments.
statusstring
Status des Dokuments, zum Beispiel Entwurf oder veröffentlicht.
requires_acknowledgmentboolean
Mitarbeitende müssen das Dokument bestätigen.
requires_signatureboolean
Mitarbeitende müssen das Dokument unterschreiben.
requires_form_fillingboolean
Mitarbeitende müssen ein Formular ausfüllen.
target_all_employeesboolean
Das Dokument gilt für alle Mitarbeitenden.
due_datestring (date-time)
Datum, bis zu dem die Antwort fällig ist.
published_atstring (date-time)
Zeitpunkt, zu dem das Dokument veröffentlicht wurde.
attachmentAttachment10
Datei, die dem Dokument beigefügt ist.
Felder anzeigen (25)
- idinteger
  Primärschlüssel des Anhangs. Interne ID.
- filenamestring
  Ursprünglicher Dateiname.
- filesizestring
  Größe der Datei in Bytes.
- mimetypestring
  MIME-Typ der Datei.
- createdbyusernamestring
  Name des Benutzers, der die Datei hochgeladen hat, als Text.
- createdstring (date-time)
  Zeitpunkt, zu dem der Anhang angelegt wurde.
- googleidstring
  ID der Datei in Google Drive.
- scopestring
  Scope, der steuert, wer den Anhang sehen kann.
- ocr_document_typestring
  Dokumenttyp, der per OCR erkannt wurde.
- ocr_from_namestring
  Per OCR erkannter Absendername.
- ocr_from_companystring
  Per OCR erkanntes Absenderunternehmen.
- ocr_from_addressstring
  Per OCR erkannte Absenderadresse.
- ocr_from_emailstring
  Per OCR erkannte Absender-E-Mail-Adresse.
- ocr_from_phonestring
  Per OCR erkannte Absender-Telefonnummer.
- ocr_to_namestring
  Per OCR erkannter Name des Empfängers.
- ocr_to_companystring
  Per OCR erkanntes Empfängerunternehmen.
- ocr_to_addressstring
  Per OCR erkannte Empfängeradresse.
- ocr_to_emailstring
  Per OCR erkannte E-Mail-Adresse des Empfängers.
- ocr_to_phonestring
  Per OCR erkannte Telefonnummer des Empfängers.
- ocr_summarystring
  Zusammenfassung des per OCR erstellten Dokuments.
- ocr_statusstring
  OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error
- ocr_errorstring
  Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war
- ocr_processed_atstring (date-time)
  Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.
- virus_checkedboolean
  1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.
- virus_checked_atstring (date-time)
  Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.
created_by_userUser14
Benutzer, der das Dokument erstellt 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.
created_by_personCRMPerson10
Person, die das Dokument angelegt hat.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
target_employeesarray<CRMPerson10>
Felder anzeigen (69)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- … 14 weitere Felder
… 9 weitere Felder

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/document \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "title": "Beispiel",
    "description": "Text",
    "document_type": "string",
    "category": "string",
    "status": "string",
    "requires_acknowledgment": true
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      title: 'Beispiel',
      description: 'Text',
      document_type: 'string',
      category: 'string',
      status: 'string',
      requires_acknowledgment: true
    }
  })
};

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

payload = { "data": {
    "title": "Beispiel",
    "description": "Text",
    "document_type": "string",
    "category": "string",
    "status": "string",
    "requires_acknowledgment": 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://eure-instanz.iw-erp.de/api/employee_documents/document', [
  'body' => '{"data":{"title":"Beispiel","description":"Text","document_type":"string","category":"string","status":"string","requires_acknowledgment":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://eure-instanz.iw-erp.de/api/employee_documents/document"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"title\":\"Beispiel\",\"description\":\"Text\",\"document_type\":\"string\",\"category\":\"string\",\"status\":\"string\",\"requires_acknowledgment\":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\":{\"title\":\"Beispiel\",\"description\":\"Text\",\"document_type\":\"string\",\"category\":\"string\",\"status\":\"string\",\"requires_acknowledgment\":true}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/employee_documents/document")
  .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://eure-instanz.iw-erp.de/api/employee_documents/document"

	payload := strings.NewReader("{\"data\":{\"title\":\"Beispiel\",\"description\":\"Text\",\"document_type\":\"string\",\"category\":\"string\",\"status\":\"string\",\"requires_acknowledgment\":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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/time_tracking_employee_document_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/time_tracking_employee_document.dart';

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

final result = await TimeTrackingEmployeeDocumentController.post(TimeTrackingEmployeeDocument.fromJson({
  "title": "Beispiel",
  "description": "Text",
  "document_type": "string",
  "category": "string",
  "status": "string",
  "requires_acknowledgment": true
}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "title": "Beispiel",
  "description": "Text",
  "token": "string",
  "document_type": "string",
  "category": "string",
  "status": "string",
  "requires_acknowledgment": true,
  "requires_signature": true,
  "requires_form_filling": true
}

Die Bestätigungen und Unterschriften einer Person über alle Dokumente hinweg auflisten.

GET/api/employee_documents/acknowledgment

Bewusst auf eine Person beschränkt: Das ist die Frage der Personalakte, und eine unbegrenzte Liste, wer was unterschrieben hat, soll nicht versehentlich herausgegeben werden. Die Person ist Pflicht, und das Lesen der Akte einer anderen Person erfordert HR-Zugriff oder Führungsrolle.

Query-Parameter

`id`integer
`document`string
`user`string
`person`string
`contract`string
`type`string
`created`string
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Bestätigungen und Unterschriften einer Personarray<EmployeeDocumentAcknowledgment>

Felder anzeigen (11)

idinteger
Primärschlüssel der Bestätigung. Interne ID.
documentEmployeeDocument4
Mitarbeiterdokument, das bestätigt wurde.
Felder anzeigen (18)
- idinteger
  Primärschlüssel des Mitarbeiterdokuments. Interne ID.
- tokenstring
  Öffentlicher Token des Dokuments. Anstelle der ID verwendet.
- titlestring
  Titel des Dokuments.
- descriptionstring
  Beschreibung des Dokuments.
- document_typestring
  Art des Dokuments, zum Beispiel Vertrag oder Bescheid.
- categorystring
  Kategorie des Dokuments.
- statusstring
  Status des Dokuments, zum Beispiel Entwurf oder veröffentlicht.
- requires_acknowledgmentboolean
  Mitarbeitende müssen das Dokument bestätigen.
- requires_signatureboolean
  Mitarbeitende müssen das Dokument unterschreiben.
- requires_form_fillingboolean
  Mitarbeitende müssen ein Formular ausfüllen.
- target_all_employeesboolean
  Das Dokument gilt für alle Mitarbeitenden.
- due_datestring (date-time)
  Datum, bis zu dem die Antwort fällig ist.
- published_atstring (date-time)
  Zeitpunkt, zu dem das Dokument veröffentlicht wurde.
- attachmentAttachment10
  Datei, die dem Dokument beigefügt ist.
- created_by_userUser14
  Benutzer, der das Dokument erstellt hat.
- 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.
userUser14
Benutzer, der das Dokument zur Kenntnis genommen 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.
personCRMPerson10
Person, die das Dokument bestätigt hat.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
contractEmploymentContract14
Arbeitsvertrag, zu dem die Bestätigung gehört.
Felder anzeigen (43)
- staged_absence_approvalboolean
  null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.
- idinteger
  Primärschlüssel des Arbeitsvertrags. Interne ID.
- tokenstring
  Öffentlicher Token des Vertrags. Anstelle der ID verwendet.
- userUser14
  Benutzer des Mitarbeiters.
- week_total_hoursnumber (float)
  Gesamte Arbeitsstunden pro Woche.
- week_total_daysnumber (float)
  Gesamte Arbeitstage pro Woche.
- reserved_hours_preparationnumber (float)
  L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_follow_upnumber (float)
  L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_travelnumber (float)
  L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_flexiblenumber (float)
  L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- week_full_time_total_daysnumber (float)
  Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.
- year_vacation_daysnumber (float)
  Urlaubstage pro Jahr.
- month_vacation_daysnumber (float)
  Urlaubstage pro Monat.
- year_vacation_weeksnumber (float)
  Urlaubswochen pro Jahr.
- monday_hoursnumber (float)
  Arbeitsstunden am Montag.
- tuesday_hoursnumber (float)
  Arbeitsstunden am Dienstag.
- wednesday_hoursnumber (float)
  Arbeitsstunden am Mittwoch.
- thursday_hoursnumber (float)
  Arbeitsstunden am Donnerstag.
- friday_hoursnumber (float)
  Arbeitsstunden am Freitag.
- saturday_hoursnumber (float)
  Arbeitsstunden am Samstag.
- sunday_hoursnumber (float)
  Arbeitsstunden am Sonntag.
- netto_hour_costnumber (float)
  Nettokosten je Stunde.
- brutto_hour_costnumber (float)
  Bruttokosten pro Stunde.
- startstring (date-time)
  Startdatum des Vertrags.
- endstring (date-time)
  Enddatum des Vertrags.
- fixed_term_statusstring
  Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).
- fixed_term_endstring (date-time)
  Befristet bis (erster Zeitraum).
- fixed_term_extension_endstring (date-time)
  Befristet bis nach Verlängerung.
- probation_endstring (date-time)
  Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.
- numberstring
  Vertragsnummer.
- descriptionstring
  Beschreibung des Vertrags.
- archivedboolean
  Der Vertrag ist archiviert.
- allow_app_time_trackingboolean
  Der Mitarbeitende darf Zeiten in der App erfassen.
- allow_scanner_time_trackingboolean
  Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.
- allow_app_non_work_time_managementboolean
  Der Mitarbeitende darf Abwesenheiten in der App verwalten.
- force_no_auto_breakboolean
  Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.
- work_time_modestring
  Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.
- holiday_credit_modestring
  Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).
- holiday_credit_fixed_secondsinteger
  Fester Feiertagsguthaben in Sekunden.
- planning_weekdays_bitmaskinteger
  ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.
- request_lead_time_daysinteger
  Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.
- shift_booking_syncboolean
  L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
typestring
Art der Bestätigung.
signature_datastring
Erfasste Signaturdaten für die Bestätigung.
signature_ip_addressstring
IP-Adresse zum Zeitpunkt der Unterschrift.
signature_user_agentstring
User-Agent zum Zeitpunkt der Signatur.
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/employee_documents/acknowledgment \
  --header 'x-iw-jwt-token: <TOKEN>'

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

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

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/employee_documents/acknowledgment', [
  '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/employee_documents/acknowledgment"),
  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/employee_documents/acknowledgment")
  .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/employee_documents/acknowledgment"

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

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

final result = await TimeTrackingEmployeeDocumentAcknowledgmentController.getAllForPerson(CrmPerson.fromJson({}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "document": {
      "id": 42,
      "title": "Beispiel",
      "description": "Text",
      "token": "string",
      "document_type": "string",
      "category": "string",
      "status": "string",
      "requires_acknowledgment": true,
      "requires_signature": true,
      "requires_form_filling": true
    },
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "contract": {
      "id": 42,
      "description": "Text",
      "staged_absence_approval": true,
      "token": "string",
      "week_total_hours": 1.5,
      "week_total_days": 1.5,
      "reserved_hours_preparation": 1.5,
      "reserved_hours_follow_up": 1.5,
      "reserved_hours_travel": 1.5,
      "reserved_hours_flexible": 1.5
    },
    "type": "string",
    "signature_data": "string",
    "signature_ip_address": "string",
    "signature_user_agent": "string",
    "created": "2026-10-15T09:30:00+02:00"
  }
]

Einzelnes EmployeeDocument abrufen

GET/api/employee_documents/document/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Einzelnes EmployeeDocument abrufenEmployeeDocument3

Felder anzeigen (18)

idinteger
Primärschlüssel des Mitarbeiterdokuments. Interne ID.
tokenstring
Öffentlicher Token des Dokuments. Anstelle der ID verwendet.
titlestring
Titel des Dokuments.
descriptionstring
Beschreibung des Dokuments.
document_typestring
Art des Dokuments, zum Beispiel Vertrag oder Bescheid.
categorystring
Kategorie des Dokuments.
statusstring
Status des Dokuments, zum Beispiel Entwurf oder veröffentlicht.
requires_acknowledgmentboolean
Mitarbeitende müssen das Dokument bestätigen.
requires_signatureboolean
Mitarbeitende müssen das Dokument unterschreiben.
requires_form_fillingboolean
Mitarbeitende müssen ein Formular ausfüllen.
target_all_employeesboolean
Das Dokument gilt für alle Mitarbeitenden.
due_datestring (date-time)
Datum, bis zu dem die Antwort fällig ist.
published_atstring (date-time)
Zeitpunkt, zu dem das Dokument veröffentlicht wurde.
attachmentAttachment10
Datei, die dem Dokument beigefügt ist.
Felder anzeigen (25)
- idinteger
  Primärschlüssel des Anhangs. Interne ID.
- filenamestring
  Ursprünglicher Dateiname.
- filesizestring
  Größe der Datei in Bytes.
- mimetypestring
  MIME-Typ der Datei.
- createdbyusernamestring
  Name des Benutzers, der die Datei hochgeladen hat, als Text.
- createdstring (date-time)
  Zeitpunkt, zu dem der Anhang angelegt wurde.
- googleidstring
  ID der Datei in Google Drive.
- scopestring
  Scope, der steuert, wer den Anhang sehen kann.
- ocr_document_typestring
  Dokumenttyp, der per OCR erkannt wurde.
- ocr_from_namestring
  Per OCR erkannter Absendername.
- ocr_from_companystring
  Per OCR erkanntes Absenderunternehmen.
- ocr_from_addressstring
  Per OCR erkannte Absenderadresse.
- ocr_from_emailstring
  Per OCR erkannte Absender-E-Mail-Adresse.
- ocr_from_phonestring
  Per OCR erkannte Absender-Telefonnummer.
- ocr_to_namestring
  Per OCR erkannter Name des Empfängers.
- ocr_to_companystring
  Per OCR erkanntes Empfängerunternehmen.
- ocr_to_addressstring
  Per OCR erkannte Empfängeradresse.
- ocr_to_emailstring
  Per OCR erkannte E-Mail-Adresse des Empfängers.
- ocr_to_phonestring
  Per OCR erkannte Telefonnummer des Empfängers.
- ocr_summarystring
  Zusammenfassung des per OCR erstellten Dokuments.
- ocr_statusstring
  OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error
- ocr_errorstring
  Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war
- ocr_processed_atstring (date-time)
  Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.
- virus_checkedboolean
  1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.
- virus_checked_atstring (date-time)
  Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.
created_by_userUser14
Benutzer, der das Dokument erstellt 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.
created_by_personCRMPerson10
Person, die das Dokument angelegt hat.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
target_employeesarray<CRMPerson10>
Felder anzeigen (69)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- … 14 weitere Felder
… 9 weitere Felder

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/document/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/employee_documents/document/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/employee_documents/document/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/employee_documents/document/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/employee_documents/document/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/employee_documents/document/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/employee_documents/document/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/time_tracking_employee_document_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 TimeTrackingEmployeeDocumentController.get('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "title": "Beispiel",
  "description": "Text",
  "token": "string",
  "document_type": "string",
  "category": "string",
  "status": "string",
  "requires_acknowledgment": true,
  "requires_signature": true,
  "requires_form_filling": true
}

EmployeeDocument einzeln aktualisieren

PUT/api/employee_documents/document/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

dataEmployeeDocument2
Felder anzeigen (13)
- titlestring
  Titel des Dokuments.
- descriptionstring
  Beschreibung des Dokuments.
- document_typestring
  Art des Dokuments, zum Beispiel Vertrag oder Bescheid.
- categorystring
  Kategorie des Dokuments.
- statusstring
  Status des Dokuments, zum Beispiel Entwurf oder veröffentlicht.
- requires_acknowledgmentboolean
  Mitarbeitende müssen das Dokument bestätigen.
- requires_signatureboolean
  Mitarbeitende müssen das Dokument unterschreiben.
- requires_form_fillingboolean
  Mitarbeitende müssen ein Formular ausfüllen.
- target_all_employeesboolean
  Das Dokument gilt für alle Mitarbeitenden.
- due_datestring (date-time)
  Datum, bis zu dem die Antwort fällig ist.
- target_employeesarray<CRMPerson41>
- target_contract_groupsarray<EmploymentContractGroup5>
- target_organizationsarray<EmploymentOrganization3>

Antworten

200EmployeeDocument einzeln aktualisierenEmployeeDocument3

Felder anzeigen (18)

idinteger
Primärschlüssel des Mitarbeiterdokuments. Interne ID.
tokenstring
Öffentlicher Token des Dokuments. Anstelle der ID verwendet.
titlestring
Titel des Dokuments.
descriptionstring
Beschreibung des Dokuments.
document_typestring
Art des Dokuments, zum Beispiel Vertrag oder Bescheid.
categorystring
Kategorie des Dokuments.
statusstring
Status des Dokuments, zum Beispiel Entwurf oder veröffentlicht.
requires_acknowledgmentboolean
Mitarbeitende müssen das Dokument bestätigen.
requires_signatureboolean
Mitarbeitende müssen das Dokument unterschreiben.
requires_form_fillingboolean
Mitarbeitende müssen ein Formular ausfüllen.
target_all_employeesboolean
Das Dokument gilt für alle Mitarbeitenden.
due_datestring (date-time)
Datum, bis zu dem die Antwort fällig ist.
published_atstring (date-time)
Zeitpunkt, zu dem das Dokument veröffentlicht wurde.
attachmentAttachment10
Datei, die dem Dokument beigefügt ist.
Felder anzeigen (25)
- idinteger
  Primärschlüssel des Anhangs. Interne ID.
- filenamestring
  Ursprünglicher Dateiname.
- filesizestring
  Größe der Datei in Bytes.
- mimetypestring
  MIME-Typ der Datei.
- createdbyusernamestring
  Name des Benutzers, der die Datei hochgeladen hat, als Text.
- createdstring (date-time)
  Zeitpunkt, zu dem der Anhang angelegt wurde.
- googleidstring
  ID der Datei in Google Drive.
- scopestring
  Scope, der steuert, wer den Anhang sehen kann.
- ocr_document_typestring
  Dokumenttyp, der per OCR erkannt wurde.
- ocr_from_namestring
  Per OCR erkannter Absendername.
- ocr_from_companystring
  Per OCR erkanntes Absenderunternehmen.
- ocr_from_addressstring
  Per OCR erkannte Absenderadresse.
- ocr_from_emailstring
  Per OCR erkannte Absender-E-Mail-Adresse.
- ocr_from_phonestring
  Per OCR erkannte Absender-Telefonnummer.
- ocr_to_namestring
  Per OCR erkannter Name des Empfängers.
- ocr_to_companystring
  Per OCR erkanntes Empfängerunternehmen.
- ocr_to_addressstring
  Per OCR erkannte Empfängeradresse.
- ocr_to_emailstring
  Per OCR erkannte E-Mail-Adresse des Empfängers.
- ocr_to_phonestring
  Per OCR erkannte Telefonnummer des Empfängers.
- ocr_summarystring
  Zusammenfassung des per OCR erstellten Dokuments.
- ocr_statusstring
  OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error
- ocr_errorstring
  Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war
- ocr_processed_atstring (date-time)
  Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.
- virus_checkedboolean
  1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.
- virus_checked_atstring (date-time)
  Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.
created_by_userUser14
Benutzer, der das Dokument erstellt 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.
created_by_personCRMPerson10
Person, die das Dokument angelegt hat.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
target_employeesarray<CRMPerson10>
Felder anzeigen (69)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- … 14 weitere Felder
… 9 weitere Felder

Anfrage

curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/document/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "title": "Beispiel",
    "description": "Text",
    "document_type": "string",
    "category": "string",
    "status": "string",
    "requires_acknowledgment": true
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      title: 'Beispiel',
      description: 'Text',
      document_type: 'string',
      category: 'string',
      status: 'string',
      requires_acknowledgment: true
    }
  })
};

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

payload = { "data": {
    "title": "Beispiel",
    "description": "Text",
    "document_type": "string",
    "category": "string",
    "status": "string",
    "requires_acknowledgment": 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://eure-instanz.iw-erp.de/api/employee_documents/document/42', [
  'body' => '{"data":{"title":"Beispiel","description":"Text","document_type":"string","category":"string","status":"string","requires_acknowledgment":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://eure-instanz.iw-erp.de/api/employee_documents/document/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"title\":\"Beispiel\",\"description\":\"Text\",\"document_type\":\"string\",\"category\":\"string\",\"status\":\"string\",\"requires_acknowledgment\":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\":{\"title\":\"Beispiel\",\"description\":\"Text\",\"document_type\":\"string\",\"category\":\"string\",\"status\":\"string\",\"requires_acknowledgment\":true}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/employee_documents/document/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/employee_documents/document/42"

	payload := strings.NewReader("{\"data\":{\"title\":\"Beispiel\",\"description\":\"Text\",\"document_type\":\"string\",\"category\":\"string\",\"status\":\"string\",\"requires_acknowledgment\":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 mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/time_tracking_employee_document_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/time_tracking_employee_document.dart';

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

final result = await TimeTrackingEmployeeDocumentController.put(TimeTrackingEmployeeDocument.fromJson({
  "title": "Beispiel",
  "description": "Text",
  "document_type": "string",
  "category": "string",
  "status": "string",
  "requires_acknowledgment": true
}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "title": "Beispiel",
  "description": "Text",
  "token": "string",
  "document_type": "string",
  "category": "string",
  "status": "string",
  "requires_acknowledgment": true,
  "requires_signature": true,
  "requires_form_filling": true
}

Eine einzelne EmployeeDocument löschen

DELETE/api/employee_documents/document/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Löscht eine einzelne EmployeeDocument, nur solange sie noch ein Entwurf istobject

Felder anzeigen (1)

successboolean

Anfrage

curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/document/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

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

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

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://eure-instanz.iw-erp.de/api/employee_documents/document/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.Delete,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/employee_documents/document/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/employee_documents/document/42")
  .delete(null)
  .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/employee_documents/document/42"

	req, _ := http.NewRequest("DELETE", 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/time_tracking_employee_document_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/time_tracking_employee_document.dart';

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

final result = await TimeTrackingEmployeeDocumentController.delete(TimeTrackingEmployeeDocument.fromJson({}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "success": true
}

Ein EmployeeDocument veröffentlichen

POST/api/employee_documents/document/{id}/publish

Pfad-Parameter

idPflichtstring

Antworten

200Ein EmployeeDocument veröffentlichenEmployeeDocument3

Felder anzeigen (18)

idinteger
Primärschlüssel des Mitarbeiterdokuments. Interne ID.
tokenstring
Öffentlicher Token des Dokuments. Anstelle der ID verwendet.
titlestring
Titel des Dokuments.
descriptionstring
Beschreibung des Dokuments.
document_typestring
Art des Dokuments, zum Beispiel Vertrag oder Bescheid.
categorystring
Kategorie des Dokuments.
statusstring
Status des Dokuments, zum Beispiel Entwurf oder veröffentlicht.
requires_acknowledgmentboolean
Mitarbeitende müssen das Dokument bestätigen.
requires_signatureboolean
Mitarbeitende müssen das Dokument unterschreiben.
requires_form_fillingboolean
Mitarbeitende müssen ein Formular ausfüllen.
target_all_employeesboolean
Das Dokument gilt für alle Mitarbeitenden.
due_datestring (date-time)
Datum, bis zu dem die Antwort fällig ist.
published_atstring (date-time)
Zeitpunkt, zu dem das Dokument veröffentlicht wurde.
attachmentAttachment10
Datei, die dem Dokument beigefügt ist.
Felder anzeigen (25)
- idinteger
  Primärschlüssel des Anhangs. Interne ID.
- filenamestring
  Ursprünglicher Dateiname.
- filesizestring
  Größe der Datei in Bytes.
- mimetypestring
  MIME-Typ der Datei.
- createdbyusernamestring
  Name des Benutzers, der die Datei hochgeladen hat, als Text.
- createdstring (date-time)
  Zeitpunkt, zu dem der Anhang angelegt wurde.
- googleidstring
  ID der Datei in Google Drive.
- scopestring
  Scope, der steuert, wer den Anhang sehen kann.
- ocr_document_typestring
  Dokumenttyp, der per OCR erkannt wurde.
- ocr_from_namestring
  Per OCR erkannter Absendername.
- ocr_from_companystring
  Per OCR erkanntes Absenderunternehmen.
- ocr_from_addressstring
  Per OCR erkannte Absenderadresse.
- ocr_from_emailstring
  Per OCR erkannte Absender-E-Mail-Adresse.
- ocr_from_phonestring
  Per OCR erkannte Absender-Telefonnummer.
- ocr_to_namestring
  Per OCR erkannter Name des Empfängers.
- ocr_to_companystring
  Per OCR erkanntes Empfängerunternehmen.
- ocr_to_addressstring
  Per OCR erkannte Empfängeradresse.
- ocr_to_emailstring
  Per OCR erkannte E-Mail-Adresse des Empfängers.
- ocr_to_phonestring
  Per OCR erkannte Telefonnummer des Empfängers.
- ocr_summarystring
  Zusammenfassung des per OCR erstellten Dokuments.
- ocr_statusstring
  OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error
- ocr_errorstring
  Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war
- ocr_processed_atstring (date-time)
  Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.
- virus_checkedboolean
  1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.
- virus_checked_atstring (date-time)
  Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.
created_by_userUser14
Benutzer, der das Dokument erstellt 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.
created_by_personCRMPerson10
Person, die das Dokument angelegt hat.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
target_employeesarray<CRMPerson10>
Felder anzeigen (69)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- … 14 weitere Felder
… 9 weitere Felder

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/document/42/publish \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/publish', 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/employee_documents/document/42/publish"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/employee_documents/document/42/publish', [
  'headers' => [
    '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://eure-instanz.iw-erp.de/api/employee_documents/document/42/publish"),
  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/employee_documents/document/42/publish")
  .post(null)
  .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/employee_documents/document/42/publish"

	req, _ := http.NewRequest("POST", 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 package:http (kein Controller im Package iw_erp_api)

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

final response = await http.post(
  Uri.parse('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/publish'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "title": "Beispiel",
  "description": "Text",
  "token": "string",
  "document_type": "string",
  "category": "string",
  "status": "string",
  "requires_acknowledgment": true,
  "requires_signature": true,
  "requires_form_filling": true
}

EmployeeDocument archivieren

POST/api/employee_documents/document/{id}/archive

Pfad-Parameter

idPflichtstring

Antworten

200EmployeeDocument archivierenEmployeeDocument3

Felder anzeigen (18)

idinteger
Primärschlüssel des Mitarbeiterdokuments. Interne ID.
tokenstring
Öffentlicher Token des Dokuments. Anstelle der ID verwendet.
titlestring
Titel des Dokuments.
descriptionstring
Beschreibung des Dokuments.
document_typestring
Art des Dokuments, zum Beispiel Vertrag oder Bescheid.
categorystring
Kategorie des Dokuments.
statusstring
Status des Dokuments, zum Beispiel Entwurf oder veröffentlicht.
requires_acknowledgmentboolean
Mitarbeitende müssen das Dokument bestätigen.
requires_signatureboolean
Mitarbeitende müssen das Dokument unterschreiben.
requires_form_fillingboolean
Mitarbeitende müssen ein Formular ausfüllen.
target_all_employeesboolean
Das Dokument gilt für alle Mitarbeitenden.
due_datestring (date-time)
Datum, bis zu dem die Antwort fällig ist.
published_atstring (date-time)
Zeitpunkt, zu dem das Dokument veröffentlicht wurde.
attachmentAttachment10
Datei, die dem Dokument beigefügt ist.
Felder anzeigen (25)
- idinteger
  Primärschlüssel des Anhangs. Interne ID.
- filenamestring
  Ursprünglicher Dateiname.
- filesizestring
  Größe der Datei in Bytes.
- mimetypestring
  MIME-Typ der Datei.
- createdbyusernamestring
  Name des Benutzers, der die Datei hochgeladen hat, als Text.
- createdstring (date-time)
  Zeitpunkt, zu dem der Anhang angelegt wurde.
- googleidstring
  ID der Datei in Google Drive.
- scopestring
  Scope, der steuert, wer den Anhang sehen kann.
- ocr_document_typestring
  Dokumenttyp, der per OCR erkannt wurde.
- ocr_from_namestring
  Per OCR erkannter Absendername.
- ocr_from_companystring
  Per OCR erkanntes Absenderunternehmen.
- ocr_from_addressstring
  Per OCR erkannte Absenderadresse.
- ocr_from_emailstring
  Per OCR erkannte Absender-E-Mail-Adresse.
- ocr_from_phonestring
  Per OCR erkannte Absender-Telefonnummer.
- ocr_to_namestring
  Per OCR erkannter Name des Empfängers.
- ocr_to_companystring
  Per OCR erkanntes Empfängerunternehmen.
- ocr_to_addressstring
  Per OCR erkannte Empfängeradresse.
- ocr_to_emailstring
  Per OCR erkannte E-Mail-Adresse des Empfängers.
- ocr_to_phonestring
  Per OCR erkannte Telefonnummer des Empfängers.
- ocr_summarystring
  Zusammenfassung des per OCR erstellten Dokuments.
- ocr_statusstring
  OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error
- ocr_errorstring
  Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war
- ocr_processed_atstring (date-time)
  Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.
- virus_checkedboolean
  1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.
- virus_checked_atstring (date-time)
  Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.
created_by_userUser14
Benutzer, der das Dokument erstellt 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.
created_by_personCRMPerson10
Person, die das Dokument angelegt hat.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
target_employeesarray<CRMPerson10>
Felder anzeigen (69)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- … 14 weitere Felder
… 9 weitere Felder

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/document/42/archive \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/archive', 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/employee_documents/document/42/archive"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/employee_documents/document/42/archive', [
  'headers' => [
    '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://eure-instanz.iw-erp.de/api/employee_documents/document/42/archive"),
  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/employee_documents/document/42/archive")
  .post(null)
  .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/employee_documents/document/42/archive"

	req, _ := http.NewRequest("POST", 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 package:http (kein Controller im Package iw_erp_api)

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

final response = await http.post(
  Uri.parse('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/archive'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "title": "Beispiel",
  "description": "Text",
  "token": "string",
  "document_type": "string",
  "category": "string",
  "status": "string",
  "requires_acknowledgment": true,
  "requires_signature": true,
  "requires_form_filling": true
}

Eine bereits hochgeladene Datei an ein EmployeeDocument anhängen. Die Datei selbst läuft zuerst über die Attachment-Endpunkte; dieser Aufruf übernimmt deren Download-Link und verknüpft ihn.

POST/api/employee_documents/document/{id}/upload

Pfad-Parameter

idPflichtstring

Request-Body application/json

simpleidobject
Felder anzeigen (1)
- idstring
  Download-Link des bereits hochgeladenen Anhangs

Antworten

200Eine Datei an ein EmployeeDocument anhängenEmployeeDocument3

Felder anzeigen (18)

idinteger
Primärschlüssel des Mitarbeiterdokuments. Interne ID.
tokenstring
Öffentlicher Token des Dokuments. Anstelle der ID verwendet.
titlestring
Titel des Dokuments.
descriptionstring
Beschreibung des Dokuments.
document_typestring
Art des Dokuments, zum Beispiel Vertrag oder Bescheid.
categorystring
Kategorie des Dokuments.
statusstring
Status des Dokuments, zum Beispiel Entwurf oder veröffentlicht.
requires_acknowledgmentboolean
Mitarbeitende müssen das Dokument bestätigen.
requires_signatureboolean
Mitarbeitende müssen das Dokument unterschreiben.
requires_form_fillingboolean
Mitarbeitende müssen ein Formular ausfüllen.
target_all_employeesboolean
Das Dokument gilt für alle Mitarbeitenden.
due_datestring (date-time)
Datum, bis zu dem die Antwort fällig ist.
published_atstring (date-time)
Zeitpunkt, zu dem das Dokument veröffentlicht wurde.
attachmentAttachment10
Datei, die dem Dokument beigefügt ist.
Felder anzeigen (25)
- idinteger
  Primärschlüssel des Anhangs. Interne ID.
- filenamestring
  Ursprünglicher Dateiname.
- filesizestring
  Größe der Datei in Bytes.
- mimetypestring
  MIME-Typ der Datei.
- createdbyusernamestring
  Name des Benutzers, der die Datei hochgeladen hat, als Text.
- createdstring (date-time)
  Zeitpunkt, zu dem der Anhang angelegt wurde.
- googleidstring
  ID der Datei in Google Drive.
- scopestring
  Scope, der steuert, wer den Anhang sehen kann.
- ocr_document_typestring
  Dokumenttyp, der per OCR erkannt wurde.
- ocr_from_namestring
  Per OCR erkannter Absendername.
- ocr_from_companystring
  Per OCR erkanntes Absenderunternehmen.
- ocr_from_addressstring
  Per OCR erkannte Absenderadresse.
- ocr_from_emailstring
  Per OCR erkannte Absender-E-Mail-Adresse.
- ocr_from_phonestring
  Per OCR erkannte Absender-Telefonnummer.
- ocr_to_namestring
  Per OCR erkannter Name des Empfängers.
- ocr_to_companystring
  Per OCR erkanntes Empfängerunternehmen.
- ocr_to_addressstring
  Per OCR erkannte Empfängeradresse.
- ocr_to_emailstring
  Per OCR erkannte E-Mail-Adresse des Empfängers.
- ocr_to_phonestring
  Per OCR erkannte Telefonnummer des Empfängers.
- ocr_summarystring
  Zusammenfassung des per OCR erstellten Dokuments.
- ocr_statusstring
  OCR-Verarbeitungsstatus: null = nicht verarbeitet, pending, processing, done, error
- ocr_errorstring
  Grund des letzten fehlgeschlagenen oder unvollständigen OCR-Laufs, null wenn er erfolgreich war
- ocr_processed_atstring (date-time)
  Zeitpunkt, zu dem die OCR-Verarbeitung abgeschlossen wurde.
- virus_checkedboolean
  1, sobald der Virenscan für diese Datei bestanden ist. Der Scan läuft im Hintergrund (AttachmentVirusScanCommand), daher beginnt eine neu hochgeladene Datei bei 0 und bleibt dort, bis sie tatsächlich geprüft wurde. Eine infizierte Datei erreicht nie 1 – sie wird stattdessen gelöscht. Die Oberflächen nutzen dies, um zu entscheiden, ob eine Datei an einen Benutzer ausgegeben werden darf; daher muss sie bis zum Nachweis des Gegenteils auf false bleiben.
- virus_checked_atstring (date-time)
  Wann der Virenscan bestanden wurde. Null, solange die Datei noch wartet.
created_by_userUser14
Benutzer, der das Dokument erstellt 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.
created_by_personCRMPerson10
Person, die das Dokument angelegt hat.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
target_employeesarray<CRMPerson10>
Felder anzeigen (69)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- … 14 weitere Felder
… 9 weitere Felder

Anfrage

curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/document/42/upload \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "simpleid": {
    "id": "42"
  }
}
'

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

fetch('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/upload', 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/employee_documents/document/42/upload"

payload = { "simpleid": { "id": "42" } }
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://eure-instanz.iw-erp.de/api/employee_documents/document/42/upload', [
  'body' => '{"simpleid":{"id":"42"}}',
  '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://eure-instanz.iw-erp.de/api/employee_documents/document/42/upload"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"simpleid\":{\"id\":\"42\"}}")
  {
    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, "{\"simpleid\":{\"id\":\"42\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/employee_documents/document/42/upload")
  .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://eure-instanz.iw-erp.de/api/employee_documents/document/42/upload"

	payload := strings.NewReader("{\"simpleid\":{\"id\":\"42\"}}")

	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 mit package:http (kein Controller im Package iw_erp_api)

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

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

Antwort 200 application/json

{
  "id": 42,
  "title": "Beispiel",
  "description": "Text",
  "token": "string",
  "document_type": "string",
  "category": "string",
  "status": "string",
  "requires_acknowledgment": true,
  "requires_signature": true,
  "requires_form_filling": true
}

EmployeeDocument bestätigen

POST/api/employee_documents/document/{id}/acknowledge

Pfad-Parameter

idPflichtstring

Antworten

200EmployeeDocument bestätigenEmployeeDocumentAcknowledgment2

Felder anzeigen (10)

idinteger
Primärschlüssel der Bestätigung. Interne ID.
userUser14
Benutzer, der das Dokument zur Kenntnis genommen 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.
personCRMPerson10
Person, die das Dokument bestätigt hat.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
contractEmploymentContract15
Arbeitsvertrag, zu dem die Bestätigung gehört.
Felder anzeigen (43)
- staged_absence_approvalboolean
  null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.
- idinteger
  Primärschlüssel des Arbeitsvertrags. Interne ID.
- tokenstring
  Öffentlicher Token des Vertrags. Anstelle der ID verwendet.
- userUser14
  Benutzer des Mitarbeiters.
- week_total_hoursnumber (float)
  Gesamte Arbeitsstunden pro Woche.
- week_total_daysnumber (float)
  Gesamte Arbeitstage pro Woche.
- reserved_hours_preparationnumber (float)
  L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_follow_upnumber (float)
  L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_travelnumber (float)
  L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_flexiblenumber (float)
  L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- week_full_time_total_daysnumber (float)
  Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.
- year_vacation_daysnumber (float)
  Urlaubstage pro Jahr.
- month_vacation_daysnumber (float)
  Urlaubstage pro Monat.
- year_vacation_weeksnumber (float)
  Urlaubswochen pro Jahr.
- monday_hoursnumber (float)
  Arbeitsstunden am Montag.
- tuesday_hoursnumber (float)
  Arbeitsstunden am Dienstag.
- wednesday_hoursnumber (float)
  Arbeitsstunden am Mittwoch.
- thursday_hoursnumber (float)
  Arbeitsstunden am Donnerstag.
- friday_hoursnumber (float)
  Arbeitsstunden am Freitag.
- saturday_hoursnumber (float)
  Arbeitsstunden am Samstag.
- sunday_hoursnumber (float)
  Arbeitsstunden am Sonntag.
- netto_hour_costnumber (float)
  Nettokosten je Stunde.
- brutto_hour_costnumber (float)
  Bruttokosten pro Stunde.
- startstring (date-time)
  Startdatum des Vertrags.
- endstring (date-time)
  Enddatum des Vertrags.
- fixed_term_statusstring
  Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).
- fixed_term_endstring (date-time)
  Befristet bis (erster Zeitraum).
- fixed_term_extension_endstring (date-time)
  Befristet bis nach Verlängerung.
- probation_endstring (date-time)
  Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.
- numberstring
  Vertragsnummer.
- descriptionstring
  Beschreibung des Vertrags.
- archivedboolean
  Der Vertrag ist archiviert.
- allow_app_time_trackingboolean
  Der Mitarbeitende darf Zeiten in der App erfassen.
- allow_scanner_time_trackingboolean
  Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.
- allow_app_non_work_time_managementboolean
  Der Mitarbeitende darf Abwesenheiten in der App verwalten.
- force_no_auto_breakboolean
  Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.
- work_time_modestring
  Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.
- holiday_credit_modestring
  Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).
- holiday_credit_fixed_secondsinteger
  Fester Feiertagsguthaben in Sekunden.
- planning_weekdays_bitmaskinteger
  ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.
- request_lead_time_daysinteger
  Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.
- shift_booking_syncboolean
  L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
typestring
Art der Bestätigung.
signature_datastring
Erfasste Signaturdaten für die Bestätigung.
signature_ip_addressstring
IP-Adresse zum Zeitpunkt der Unterschrift.
signature_user_agentstring
User-Agent zum Zeitpunkt der Signatur.
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/employee_documents/document/42/acknowledge \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/acknowledge', 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/employee_documents/document/42/acknowledge"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/employee_documents/document/42/acknowledge', [
  'headers' => [
    '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://eure-instanz.iw-erp.de/api/employee_documents/document/42/acknowledge"),
  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/employee_documents/document/42/acknowledge")
  .post(null)
  .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/employee_documents/document/42/acknowledge"

	req, _ := http.NewRequest("POST", 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 package:http (kein Controller im Package iw_erp_api)

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

final response = await http.post(
  Uri.parse('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/acknowledge'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "profile_picture_url": "https://vynst.de",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "contract": {
    "id": 42,
    "description": "Text",
    "staged_absence_approval": true,
    "token": "string",
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "reserved_hours_preparation": 1.5,
    "reserved_hours_follow_up": 1.5,
    "reserved_hours_travel": 1.5
  },
  "type": "string",
  "signature_data": "string",
  "signature_ip_address": "string",
  "signature_user_agent": "string",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Ein EmployeeDocument unterschreiben

POST/api/employee_documents/document/{id}/sign

Pfad-Parameter

idPflichtstring

Request-Body application/json

dataobject
Felder anzeigen (1)
- signatureDatastring
  die gezeichnete Unterschrift als Base64-kodiertes Bild

Antworten

200Ein EmployeeDocument unterschreibenEmployeeDocumentAcknowledgment2

Felder anzeigen (10)

idinteger
Primärschlüssel der Bestätigung. Interne ID.
userUser14
Benutzer, der das Dokument zur Kenntnis genommen 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.
personCRMPerson10
Person, die das Dokument bestätigt hat.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
contractEmploymentContract15
Arbeitsvertrag, zu dem die Bestätigung gehört.
Felder anzeigen (43)
- staged_absence_approvalboolean
  null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.
- idinteger
  Primärschlüssel des Arbeitsvertrags. Interne ID.
- tokenstring
  Öffentlicher Token des Vertrags. Anstelle der ID verwendet.
- userUser14
  Benutzer des Mitarbeiters.
- week_total_hoursnumber (float)
  Gesamte Arbeitsstunden pro Woche.
- week_total_daysnumber (float)
  Gesamte Arbeitstage pro Woche.
- reserved_hours_preparationnumber (float)
  L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_follow_upnumber (float)
  L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_travelnumber (float)
  L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_flexiblenumber (float)
  L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- week_full_time_total_daysnumber (float)
  Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.
- year_vacation_daysnumber (float)
  Urlaubstage pro Jahr.
- month_vacation_daysnumber (float)
  Urlaubstage pro Monat.
- year_vacation_weeksnumber (float)
  Urlaubswochen pro Jahr.
- monday_hoursnumber (float)
  Arbeitsstunden am Montag.
- tuesday_hoursnumber (float)
  Arbeitsstunden am Dienstag.
- wednesday_hoursnumber (float)
  Arbeitsstunden am Mittwoch.
- thursday_hoursnumber (float)
  Arbeitsstunden am Donnerstag.
- friday_hoursnumber (float)
  Arbeitsstunden am Freitag.
- saturday_hoursnumber (float)
  Arbeitsstunden am Samstag.
- sunday_hoursnumber (float)
  Arbeitsstunden am Sonntag.
- netto_hour_costnumber (float)
  Nettokosten je Stunde.
- brutto_hour_costnumber (float)
  Bruttokosten pro Stunde.
- startstring (date-time)
  Startdatum des Vertrags.
- endstring (date-time)
  Enddatum des Vertrags.
- fixed_term_statusstring
  Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).
- fixed_term_endstring (date-time)
  Befristet bis (erster Zeitraum).
- fixed_term_extension_endstring (date-time)
  Befristet bis nach Verlängerung.
- probation_endstring (date-time)
  Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.
- numberstring
  Vertragsnummer.
- descriptionstring
  Beschreibung des Vertrags.
- archivedboolean
  Der Vertrag ist archiviert.
- allow_app_time_trackingboolean
  Der Mitarbeitende darf Zeiten in der App erfassen.
- allow_scanner_time_trackingboolean
  Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.
- allow_app_non_work_time_managementboolean
  Der Mitarbeitende darf Abwesenheiten in der App verwalten.
- force_no_auto_breakboolean
  Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.
- work_time_modestring
  Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.
- holiday_credit_modestring
  Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).
- holiday_credit_fixed_secondsinteger
  Fester Feiertagsguthaben in Sekunden.
- planning_weekdays_bitmaskinteger
  ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.
- request_lead_time_daysinteger
  Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.
- shift_booking_syncboolean
  L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
typestring
Art der Bestätigung.
signature_datastring
Erfasste Signaturdaten für die Bestätigung.
signature_ip_addressstring
IP-Adresse zum Zeitpunkt der Unterschrift.
signature_user_agentstring
User-Agent zum Zeitpunkt der Signatur.
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/employee_documents/document/42/sign \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "signatureData": "string"
  }
}
'

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

fetch('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/sign', 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/employee_documents/document/42/sign"

payload = { "data": { "signatureData": "string" } }
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://eure-instanz.iw-erp.de/api/employee_documents/document/42/sign', [
  'body' => '{"data":{"signatureData":"string"}}',
  '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://eure-instanz.iw-erp.de/api/employee_documents/document/42/sign"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"signatureData\":\"string\"}}")
  {
    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\":{\"signatureData\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/employee_documents/document/42/sign")
  .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://eure-instanz.iw-erp.de/api/employee_documents/document/42/sign"

	payload := strings.NewReader("{\"data\":{\"signatureData\":\"string\"}}")

	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 mit package:http (kein Controller im Package iw_erp_api)

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

final response = await http.post(
  Uri.parse('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/sign'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "signatureData": "string"
    }
  }),
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "profile_picture_url": "https://vynst.de",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "contract": {
    "id": 42,
    "description": "Text",
    "staged_absence_approval": true,
    "token": "string",
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "week_total_hours": 1.5,
    "week_total_days": 1.5,
    "reserved_hours_preparation": 1.5,
    "reserved_hours_follow_up": 1.5,
    "reserved_hours_travel": 1.5
  },
  "type": "string",
  "signature_data": "string",
  "signature_ip_address": "string",
  "signature_user_agent": "string",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Bestätigungen für ein EmployeeDocument abrufen

GET/api/employee_documents/document/{id}/acknowledgments

Pfad-Parameter

idPflichtstring

Query-Parameter

`id`integer
`document`string
`user`string
`person`string
`contract`string
`type`string
`created`string
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Bestätigungen für ein Dokument abrufenarray<EmployeeDocumentAcknowledgment2>

Felder anzeigen (10)

idinteger
Primärschlüssel der Bestätigung. Interne ID.
userUser14
Benutzer, der das Dokument zur Kenntnis genommen 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.
personCRMPerson10
Person, die das Dokument bestätigt hat.
Felder anzeigen (81)
- idinteger
  Primärschlüssel der Person. Interne ID.
- first_namestring
  Vorname der Person.
- last_namestring
  Nachname der Person.
- numberinteger
  Mitglieds- oder Kundennummer der Person.
- manual_numberinteger
  Manuell gesetzte Nummer statt der automatischen Nummer.
- number_stringstring
  Mitglieds- oder Kundennummer als Text, einschließlich Präfix.
- genderstring
  Geschlecht der Person.
- titlestring
  Akademischer oder sonstiger Titel der Person.
- positionstring
  Position oder Rolle der Person.
- languagestring
  Bevorzugte Sprache der Person.
- special_salutationstring
  Besonderer Anredetext für Briefe.
- form_of_salutationstring
  Form der Anrede, zum Beispiel förmlich oder informell.
- birthdaystring (date-time)
  Geburtstag der Person.
- known_allergiesstring
  Bekannte Allergien der Person.
- confirmed_no_allergiesboolean
  Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.
- allow_photosboolean
  Fotos der Person dürfen aufgenommen und veröffentlicht werden.
- allow_leaving_aloneboolean
  Die Person darf die Veranstaltung allein verlassen.
- authorized_pickupstring
  Personen, die die Person abholen dürfen.
- needs_supportboolean
  Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.
- support_descriptionstring
  Beschreibung der Unterstützung, die die Person benötigt.
- financial_supportboolean
  Die Person erhält finanzielle Unterstützung.
- financial_support_numberstring
  Nummer der finanziellen Förderung.
- municipal_supportboolean
  Die Person erhält kommunale Unterstützung.
- municipal_support_numberstring
  Nummer der kommunalen Förderung.
- grade_levelinteger
  Schuljahrgang der Person.
- school_classstring
  Schulklasse der Person.
- start_timestring (date-time)
  Beginn der Mitgliedschaft oder Aktivität.
- start_time_reasonstring
  Grund für den Beginn.
- end_timestring (date-time)
  Ende der Mitgliedschaft oder Aktivität.
- end_time_reasonstring
  Grund für das Ende.
- confirmed_gtc_timestring (date-time)
  Zeitpunkt, zu dem die AGB bestätigt wurden.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.
- chatbot_opt_in_text_versionstring
  Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.
- app_usage_statistics_opt_outboolean
  Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.
- archivedboolean
  Ob die Person archiviert ist.
- subscribed_newsletterboolean
  Ob die Person den Newsletter abonniert hat.
- subscribed_magazineboolean
  Ob die Person das Magazin abonniert hat.
- printed_member_cardboolean
  Ob für die Person ein Mitgliedsausweis gedruckt wurde.
- has_login_userboolean
  Ob die Person einen Anmelde-Benutzer hat.
- profile_picture_urlstring
  URL des Profilbilds der Person.
- log_book_staffboolean
  Logbuch-Kennzeichen: Personal.
- log_book_staff1boolean
  Logbuch-Kennzeichen: Personal, Stufe 1.
- log_book_staff2boolean
  Logbuch-Kennzeichen: Personal, Stufe 2.
- log_book_memberboolean
  Logbuch-Kennzeichen: Mitglied.
- log_book_trainerboolean
  Logbuch-Kennzeichen: Trainer.
- log_book_trainer1boolean
  Logbuch-Kennzeichen: Trainer, Stufe 1.
- log_book_trainer2boolean
  Logbuch-Kennzeichen: Trainer, Stufe 2.
- log_book_head_of_departmentboolean
  Logbuch-Kennzeichen: Abteilungsleitung.
- log_book_supervisory_boardboolean
  Logbuch-Kennzeichen: Aufsichtsrat.
- log_book_board_of_directorsboolean
  Logbuch-Kennzeichen: Vorstand.
- log_book_honorary_memberboolean
  Logbuch-Kennzeichen: Ehrenmitglied.
- log_book_club_card_oneboolean
  Logbuch-Kennzeichen: Vereinskarte.
- log_book_health_recoveredboolean
  Logbuch-Kennzeichen: von Krankheit genesen.
- log_book_health_vaccinatedboolean
  Logbuch-Kennzeichen: geimpft.
- log_book_health_vaccinated_additionstring
  Details der Impfung.
- log_book_good_conductboolean
  Logbuch-Kennzeichen: Führungszeugnis.
- log_book_first_aidboolean
  Logbuch-Kennzeichen: Erste-Hilfe-Schulung.
- log_book_measles_vaccinationboolean
  Logbuch-Kennzeichen: Masernimpfung.
- sync_lanistaboolean
  Ob die Person mit Lanista synchronisiert ist.
- categoryCRMPersonCategory
  Personenkategorie.
- nicknamestring
  Spitzname der Person.
- preferred_color_hexstring
  Bevorzugte Farbe der Person als Hexwert.
- avatar_tokenstring
  Token des Avatarbildes.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- … 2 weitere Felder
contractEmploymentContract15
Arbeitsvertrag, zu dem die Bestätigung gehört.
Felder anzeigen (43)
- staged_absence_approvalboolean
  null übernimmt zuerst die Gruppen- und dann die Organisationsrichtlinie; bestehende Installationen bleiben aus.
- idinteger
  Primärschlüssel des Arbeitsvertrags. Interne ID.
- tokenstring
  Öffentlicher Token des Vertrags. Anstelle der ID verwendet.
- userUser14
  Benutzer des Mitarbeiters.
- week_total_hoursnumber (float)
  Gesamte Arbeitsstunden pro Woche.
- week_total_daysnumber (float)
  Gesamte Arbeitstage pro Woche.
- reserved_hours_preparationnumber (float)
  L03: wöchentliche Stunden, die für Vorbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_follow_upnumber (float)
  L03: wöchentliche Stunden, die für Nachbereitung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_travelnumber (float)
  L03: wöchentliche Stunden, die für Fahrt reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- reserved_hours_flexiblenumber (float)
  L03: wöchentliche Stunden, die für freie Einteilung reserviert sind - Teil der Vertragsstunden, aber nicht planbar im Schichtplan. null = keine.
- week_full_time_total_daysnumber (float)
  Gesamte Arbeitstage pro Woche bei einem Vollzeitvertrag.
- year_vacation_daysnumber (float)
  Urlaubstage pro Jahr.
- month_vacation_daysnumber (float)
  Urlaubstage pro Monat.
- year_vacation_weeksnumber (float)
  Urlaubswochen pro Jahr.
- monday_hoursnumber (float)
  Arbeitsstunden am Montag.
- tuesday_hoursnumber (float)
  Arbeitsstunden am Dienstag.
- wednesday_hoursnumber (float)
  Arbeitsstunden am Mittwoch.
- thursday_hoursnumber (float)
  Arbeitsstunden am Donnerstag.
- friday_hoursnumber (float)
  Arbeitsstunden am Freitag.
- saturday_hoursnumber (float)
  Arbeitsstunden am Samstag.
- sunday_hoursnumber (float)
  Arbeitsstunden am Sonntag.
- netto_hour_costnumber (float)
  Nettokosten je Stunde.
- brutto_hour_costnumber (float)
  Bruttokosten pro Stunde.
- startstring (date-time)
  Startdatum des Vertrags.
- endstring (date-time)
  Enddatum des Vertrags.
- fixed_term_statusstring
  Befristung: PERMANENT (unbefristet, Standard), FIXED_TERM oder EXTENDED (FIXED_TERM_STATUS_*).
- fixed_term_endstring (date-time)
  Befristet bis (erster Zeitraum).
- fixed_term_extension_endstring (date-time)
  Befristet bis nach Verlängerung.
- probation_endstring (date-time)
  Probezeit bis; wird aus den probationMonths der Vorlage gefüllt, wenn ein Vertrag ohne diese Angabe angelegt wird.
- numberstring
  Vertragsnummer.
- descriptionstring
  Beschreibung des Vertrags.
- archivedboolean
  Der Vertrag ist archiviert.
- allow_app_time_trackingboolean
  Der Mitarbeitende darf Zeiten in der App erfassen.
- allow_scanner_time_trackingboolean
  Der Mitarbeitende darf Zeiten mit dem Scanner erfassen.
- allow_app_non_work_time_managementboolean
  Der Mitarbeitende darf Abwesenheiten in der App verwalten.
- force_no_auto_breakboolean
  Für diesen Vertrag werden keine automatischen Pausen hinzugefügt.
- work_time_modestring
  Wie die Sollarbeitszeit definiert ist - null verhält sich wie WEEKDAY_HOURS, damit bestehende Verträge ihr bisheriges Verhalten unverändert beibehalten.
- holiday_credit_modestring
  Feiertagsguthaben für WEEK_TOTAL-Verträge - null verhält sich wie WEEKDAY_TARGET (bisheriges Verhalten, nur bei WEEKDAY_HOURS-Verträgen sinnvoll).
- holiday_credit_fixed_secondsinteger
  Fester Feiertagsguthaben in Sekunden.
- planning_weekdays_bitmaskinteger
  ISO-Wochentagsbitmaske (Mo=1 ... So=64) der Tage, an denen dieser WEEK_TOTAL-Vertrag eingeplant werden bzw. Urlaub nehmen kann - null verhält sich wie Mo-Fr.
- request_lead_time_daysinteger
  Tage, die ein Abwesenheitsantrag vor seinem ersten Tag eingereicht werden muss ("Bearbeitungs- frist"). null greift zunächst auf die Vertragsgruppe und von dort auf die Einstellung der Installation zurück, damit ein bestehender Vertrag genau wie bisher funktioniert.
- shift_booking_syncboolean
  L35: Schichten als Verfügbarkeiten / Termine im Buchungsbereich; null übernimmt die Gruppe (die wiederum die Organisation übernimmt).
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
typestring
Art der Bestätigung.
signature_datastring
Erfasste Signaturdaten für die Bestätigung.
signature_ip_addressstring
IP-Adresse zum Zeitpunkt der Unterschrift.
signature_user_agentstring
User-Agent zum Zeitpunkt der Signatur.
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/employee_documents/document/42/acknowledgments \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/acknowledgments', 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/employee_documents/document/42/acknowledgments"

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/employee_documents/document/42/acknowledgments', [
  '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/employee_documents/document/42/acknowledgments"),
  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/employee_documents/document/42/acknowledgments")
  .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/employee_documents/document/42/acknowledgments"

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

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

final result = await TimeTrackingEmployeeDocumentController.getAcknowledgments(TimeTrackingEmployeeDocument.fromJson({}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "contract": {
      "id": 42,
      "description": "Text",
      "staged_absence_approval": true,
      "token": "string",
      "week_total_hours": 1.5,
      "week_total_days": 1.5,
      "reserved_hours_preparation": 1.5,
      "reserved_hours_follow_up": 1.5,
      "reserved_hours_travel": 1.5,
      "reserved_hours_flexible": 1.5
    },
    "type": "string",
    "signature_data": "string",
    "signature_ip_address": "string",
    "signature_user_agent": "string",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
]

Statusübersicht für ein EmployeeDocument abrufen (wer bestätigt hat, wer nicht)

GET/api/employee_documents/document/{id}/status

Pfad-Parameter

idPflichtstring

Antworten

200Wer Adressat des Dokuments war und wer bereits bestätigt, unterschrieben oder geantwortet hatobject

Felder anzeigen (2)

successboolean
dataobject
Felder anzeigen (6)
- totalTargetedinteger
- totalAcknowledgedinteger
- totalPendingAcknowledgmentinteger
- totalResponsesinteger
- totalPendingResponseinteger
- acknowledgmentsarray<EmployeeDocumentAcknowledgment>

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/document/42/status \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://eure-instanz.iw-erp.de/api/employee_documents/document/42/status', 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/employee_documents/document/42/status"

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/employee_documents/document/42/status', [
  '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/employee_documents/document/42/status"),
  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/employee_documents/document/42/status")
  .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/employee_documents/document/42/status"

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

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

final result = await TimeTrackingEmployeeDocumentController.getStatus(TimeTrackingEmployeeDocument.fromJson({}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "success": true,
  "data": {
    "totalTargeted": 1,
    "totalAcknowledged": 1,
    "totalPendingAcknowledgment": 1,
    "totalResponses": 1,
    "totalPendingResponse": 1
  }
}

Dashboard-Übersicht für den aktuellen Benutzer abrufen

GET/api/employee_documents/dashboard

Antworten

200Was der angemeldete Benutzer noch erledigen muss: Dokumente, die auf eine Kenntnisnahme, eine Unterschrift oder ein ausgefülltes Formular wartenobject

Felder anzeigen (2)

successboolean
dataobject
Felder anzeigen (6)
- pendingAcknowledgmentinteger
- pendingSignatureinteger
- pendingFormFillinginteger
- pendingAcknowledgmentDocumentsarray<EmployeeDocument>
- pendingSignatureDocumentsarray<EmployeeDocument>
- pendingFormFillingDocumentsarray<EmployeeDocument>

Anfrage

curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/employee_documents/dashboard \
  --header 'x-iw-jwt-token: <TOKEN>'

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

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

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/employee_documents/dashboard', [
  '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/employee_documents/dashboard"),
  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/employee_documents/dashboard")
  .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/employee_documents/dashboard"

	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/time_tracking_employee_document_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 TimeTrackingEmployeeDocumentController.getDashboard();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "success": true,
  "data": {
    "pendingAcknowledgment": 1,
    "pendingSignature": 1,
    "pendingFormFilling": 1
  }
}