DE
Die CrewBrain REST-API bietet Ihnen die Möglichkeit, von außen auf die Daten des Systems zuzugreifen und neue Daten anzulegen oder vorhandene Daten zu verändern. Hierzu stehen viele verschiedene Funktionen zur Verfügung, mit denen Sie sowohl auf Stammdaten (Mitarbeiter, Freelancer, Kategorien, etc.) als auch Bewegungsdaten (Jobs, etc.) zugreifen können.
Die Kommunikation mit CrewBrain ist ausschließlich über verschlüsselte SSL-Verbindungen möglich. Zur Authentifizierung stellt CrewBrain zwei Varianten zur Verfügung: HTTP-Basis-Authentifizierung und ein Accesstoken. Letzteres sollte bevorzugt verwendet werden, damit kein Passwort in der API-Implementierung gespeichert werden muss.
Die HTTP-Basis-Authentifizierung stellt die einfachste Anmeldemethode dar. Hierzu geben Sie einfach jedem Aufruf der REST-API einen gültigen Benutzernamen und das zugehörige Passwort mit.
Durch die Nutzung eines Access- oder API-Tokens muss das Passwort des Nutzers nur einmalig zur initialen Authenzifizierung abgefragt werden, für die weitere Kommunikation wird das Accesstoken verwendet. Diese Tokens haben in CrewBrain eine Gültigkeit von 14 Tagen nach der letzten Verwendung und können von jedem Benutzer unter "Mein Account" > "Aktive Sitzungen" verwaltet werden.
Alle Accesstokens in CrewBrain sind an einen Benutzer gebunden und berechtigen zu denselben Funktionen, zu denen auch der Benutzer berechtigt ist. Um ein Accesstoken zu erhalten, muss folgender GET-Request mit Basic Authentication (Username & Passwort) ausgeführt werden:
Die Antwort auf diesen Abruf ist ein JSON-Objekt, welches ein gültiges Accesstoken enthält. Dieses kann bei weiteren Requests anstelle der Basic Authentification verwendet werden. Dazu wird das Token im Header X-API-KEY übergeben.
Die CrewBrain REST-API erlaubt den Zugriff auf Ressourcen (Datentypen) über URI-Pfade. Um die REST-API zu nutzen muss Ihre Anwendung eine HTTP-Anfrage stellen und die Antwort auswerten. Die CrewBrain API nutzt das JSON-Format und HTTP-Statuscodes als Rückgabeformat sowie die HTTP-Methoden wie GET, POST, PUT und DELETE. URIs für die CrewBrain REST-API haben die folgende Struktur:
Jedes Objekt wird in der CrewBrain-Datenbank mit einer eindeutigen ID hinterlegt. Diese ist im gleichnamigen Feld ID in jedem Objekt gespeichert und dient auch zur Identifikation der Objekte in der API (z.B. als jobID, docID, etc.). Parallel dazu existiert in allen Stammdaten-Objekten das Feld FremdID, welches eine bis zu 32 Zeichen lange ID eines Fremdsystems aufnehmen kann. In diesem Feld können Sie die technische ID von Fremdsystemen hinterlegen, die entsprechenden Objekte lassen sich dann auch in der API direkt über die Fremd-ID selektieren:
Als Grundlage für die Datumswerte setzt die Schnittstelle auf das Format ISO 8601. Ein Datum wird von der API in der Form 2019-01-01 ausgegeben, ein Datum mit Zeitangabe in der Form 20190101T235959Z. Wenn Sie Daten an die API senden akzeptiert die Schnittstelle neben diesen Formaten auch die Formate 2019-01-01T23:59:59Z sowie 2019-01-01T23:59:59+00:00. Die Werte werden von der Schnittstelle automatisch in die in CrewBrain hinterlegte Zeitzone konvertiert.
Die Kodierung für alle Aufrufe ist UTF-8. Dies gilt sowohl für das JSON-Objekt, welches an die REST-API übermittelt wird als auch für die Antworten, die an den Client zurückgeliefert werden.
Für die Nutzung unserer API gelten die folgenden Durchsatzbegrenzungen:
Bietet Zugriff auf die Kalendar-Darstellung
Gibt alle relevanten Felder für einen Kalendereintrag (Titel, Zugehoerigkeit, Kategorie, etc.) geordnet nach Tagen zurück.
AnfrageBietet Zugriff auf die Jobs des aktuell angemeldeten Benutzers
Gibt die Jobs zurück, zu denen der aktuell angemeldete Benutzer angefragt oder gebucht ist.
AntwortenBietet Zugriff auf Jobs und deren Informationen
Gibt den durch die jobId angeforderten Job zurück. Als jobId kann hierbei sowohl die technische ID als auch die JobID bzw. JobIDManuell angegeben werden.
Das Rückgabeobjekt enthält neben den eigentlichen Job-Informationen auch direkt Informationen zu vielen Unterelementen. So sind beispielsweise die Unterjobs sowie angefragte bzw. gebuchte Mitarbeiter im Rückgabeobjekt enthalten.
AntwortenErzeugt einen Job oder Unterjob auf Basis eines JSON-Objekts. Der Aufbau des JSON-Objekts ist hierbei zum großen Teil identisch mit dem JSON-Objekt, welches bei einem Aufruf von GET durch die API zurückgegeben wird, jedoch werden die Unterobjekte (Unterjobs, geplante Mitarbeiter, etc.) nicht berücksichtigt. Um einen Hauptjob mit Unterjobs anzulegen ist somit zunächst ein Aufruf mit den Daten für den Hauptjob notwendig, anschließend können mir der zurückgegebenen technischen ID die Unterjobs angelegt werden.
Einen Unterjob (oder einen Job zu einem Projekt) anzulegen funktioniert analog dem Anlegen eines Jobs, jedoch muss hierbei die Variable ParentID angegeben werden. Bitte beachten Sie hierbei, dass hier die technische ID des Jobs / Projekts angegeben werden muss und nicht die JobID bzw. JobIDManuell.
Um den Jobtyp, einen Kunden oder eine Location für den Job anzugeben bestehen im Rahmen dieses Aufrufs mehrere Möglichkeiten: über die Felder Typ, KundenID und Kunde bzw. LocationID und Location kann jeweils die technische ID der entsprechenden Ressource übergeben werden. Alternativ ist es möglich, über die Felder Typ, Kunde oder Location auch den Namen bzw. die Bezeichnung der Ressource zu übergeben, sofern diese im System eindeutig ist.
AnfrageAktualisiert den durch die jobId identifizierten Job oder Unterjob mit den übergebenen Werten. Der Aufbau des JSON-Objekts ist hierbei zum großen Teil identisch mit dem JSON-Objekt, welches bei einem Aufruf von GET durch die API zurückgegeben wird, jedoch werden die Unterobjekte (Unterjobs, geplante Mitarbeiter, etc.) nicht berücksichtigt. Hierbei sind grundsätzlich alle Werte optional, sodass Sie entweder einen per GET abgerufenen Job manipulieren oder ein neues Objekt mit nur einzelnen Werten erstellen und übergeben können.
Um den Jobtyp, einen Kunden oder eine Location für den Job anzugeben bestehen im Rahmen dieses Aufrufs mehrere Möglichkeiten: über die Felder Typ, KundenID und Kunde bzw. LocationID und Location kann jeweils die technische ID der entsprechenden Ressource übergeben werden. Alternativ ist es möglich, über die Felder Typ, Kunde oder Location auch den Namen bzw. die Bezeichnung der Ressource zu übergeben, sofern diese im System eindeutig ist.
AnfrageLöscht den durch die jobId identifizierten Job oder Unterjob aus dem System. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenDurchsucht die Job-Datenbank nach Jobs mit dem Suchwort Suchtext.
Durch die Parameter Limit und Start lässt sich die maximale Anzahl sowie das Paging der Datensätze steuern. Der maximale Wert beträgt 100 Datensätze. Wurden keine Datensätze gefunden, so wird ein leeres JSON-Array zurückgegeben. Der optionale Parameter NurKuenftige erlaubt Ihnen, die Suche auf Jobs in der Zukunft einzuschränken (Standard) oder auch vergangene Jobs zu durchsuchen. Mit den ebenfalls optionalen Parametern DatumVon und DatumBis kann der Zeitraum beliebig eingeschränkt werden, durch den Parameter MitarbeiterID kann das Ergebnis auf Jobs eingeschränkt werden, in denen der Mitarbeiter mit der betreffenden ID angefragt oder gebucht ist.
AnfrageGibt alle zu diesem Objekt gespeicherten Dokumente zurück. Hierbei werden jedoch nur die allgemeinen Informationen wie Dateiname und Typ zurückgegeben, um das Dokument selbst aufzurufen ist ein unabhängiger REST-Aufruf notwendig (siehe /dokument/).
AntwortenGibt das durch die docId spezifizierte Dokument zurück. Hierbei wird neben den Informationen wie Dateiname und Typ auch die Datei als base64-codierter String geliefert.
AntwortenSpeichert ein als base64-codierten String übergebenes Dokument zu dem genannten Job oder Projekt. Der JSON-Datensatz enthält hierbei lediglich drei Attribute: Dateiname, Dateiendung und Datei.
AnfrageAktualisiert das durch die docId definierte Dokument. Der JSON-Datensatz enthält wie auch der POST Request nur drei Attribute, wobei diese alle optional sind. Wenn Sie also nur den Dateinamen oder nur den Dateiinhalt ändern möchten, so müssen Sie die anderen Attribute nicht zwingend befüllen.
AnfrageLöscht das durch die {docId} identifizierte Dokument. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt die Mitarbeiter- oder Fahrzeug-Kategorien zu einem Job zurück. Jeder Eintrag enthält einen Verweis auf eine Mitarbeiter- oder Fahrzeug-Kategorie (siehe api/stammdaten/kategorie oder api/stammdaten/fahrzeugkategorie) sowie die Anzahl der in edieser Kategorie benötigten Ressourcen.
AntwortenGibt die durch die kategorieId spezifizierte Kategorie des Jobs zurück. Die Kategorie enthält im Attribut KategorieID einen Verweis auf eine Mitarbeiter- oder Fahrzeug-Kategorie (siehe api/stammdaten/kategorie oder api/stammdaten/fahrzeugkategorie).
AntwortenVerknüpft den genannten Job mit einer Mitarbeiter- oder Fahrzeug-Kategorie. Hierbei kann neben der KategorieID (die technische ID einer Kategorie, siehe api/stammdaten/kategorie oder api/stammdaten/fahrzeugkategorie) auch die Anzahl der benötigten Ressourcen angegeben werden.
AnfrageAktualisiert die durch die kategorieId definierte Kategorie. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
AnfrageLöscht die durch die {kategorieId} identifizierte Verknüpfung zwischen Job und Kategorie. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig. Beim Löschen dieser Verknüpfung werden automatisch alle Mitarbeiter-Anfragen oder -Buchungen dieser Kategorie gelöscht bzw. storniert.
AntwortenGibt den durch die terminMitarbeiterId spezifizierten Mitarbeiter des Jobs zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Mitarbeiter-, sondern um den Anfrage- bzw. Buchungs-Datensatz eines Mitarbeiters handelt. Entsprechend unterscheidet sich die terminMitarbeiterId von den IDs der Mitarbeiter. Der Verweis auf den tatsächlichen Mitarbeiter findet sich im Datensatz in den Feldern Zugehoerigkeit (Werte M für Mitarbeiter und D für Dienstleister) und ZugehoerigkeitID.
AntwortenVerknüpft den genannten Job mit einem Mitarbeiter. Hierbei kann neben der ZugehoerigkeitID (die technische ID eines Mitarbeiters, siehe api/stammdaten/mitarbeiter) und der Zugehoerigkeit (M für Mitarbeiter und Freelancer, D für Dienstleister - wird automatisch vom System anhand der gewählten Person gefüllt) auch angegeben werden, ob der Mitarbeiter Verfügbar ist oder als gebucht markiert sein soll.
AnfrageAktualisiert den durch die terminMitarbeiterId definierten Mitarbeiter bzw. die entsprechende Anfrage. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der Zugehoerigkeit (und der ZugehoerigkeitID) nicht möglich. Wenn ein Mitarbeiter ausgetauscht werden soll muss er gelöscht und erneut angelegt werden.
AnfrageLöscht die durch die {terminMitarbeiterId} identifizierte Verknüpfung zwischen Job und Mitarbeiter. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig. Beim Löschen dieser Verknüpfung wird die dahinterliegende Buchung automatisch gelöscht bzw. storniert.
AntwortenAktualisiert mehrere Mitarbeiter bzw. die entsprechende Anfragen auf Basis eines übergebenen JSON-Arrays. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Zur Identifikation der einzelnen Objekte muss jedoch für jedes Objekt des Arrays zwingend das Attribut ID übergeben werden. Aus technischen Gründen ist eine Änderung der Zugehoerigkeit (und der ZugehoerigkeitID) nicht möglich. Wenn ein Mitarbeiter ausgetauscht werden soll muss er gelöscht und erneut angelegt werden.
AnfrageGibt das durch die terminFahrzeugId spezifizierte Fahrzeug des Jobs zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Fahrzeug-, sondern um den Anfrage- bzw. Buchungs-Datensatz eines Fahrzeugs handelt. Entsprechend unterscheidet sich die terminFahrzeugId von den IDs des Fahrzeugs. Der Verweis auf das tatsächliche Fahrzeug findet sich im Datensatz im Feld ZugehoerigkeitID.
AntwortenVerknüpft den genannten Job mit einem Fahrzeug. Hierbei kann neben der ZugehoerigkeitID (die technische ID eines Mitarbeiters, siehe api/stammdaten/fahrzeug) und der Zugehoerigkeit (F für Fahrzeuge - wird automatisch vom System gefüllt) auch angegeben werden, ob das Fahrzeug Verfügbar ist oder als gebucht markiert sein soll.
AnfrageAktualisiert das durch die terminFahrzeugId definierte Fahrzeug bzw. die entsprechende Anfrage. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der Zugehoerigkeit (und der ZugehoerigkeitID) nicht möglich. Wenn ein Fahrzeug ausgetauscht werden soll muss es gelöscht und erneut angelegt werden.
AnfrageLöscht die durch die {terminFahrzeugId} identifizierte Verknüpfung zwischen Job und Fahrzeug. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig. Beim Löschen dieser Verknüpfung wird die dahinterliegende Buchung automatisch gelöscht bzw. storniert.
AntwortenAktualisiert mehrere Fahrzeuge bzw. die entsprechende Anfragen auf Basis eines übergebenen JSON-Arrays. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Zur Identifikation der einzelnen Objekte muss jedoch für jedes Objekt des Arrays zwingend das Attribut ID übergeben werden. Aus technischen Gründen ist eine Änderung der Zugehoerigkeit (und der ZugehoerigkeitID) nicht möglich. Wenn ein Fahrzeug ausgetauscht werden soll muss es gelöscht und erneut angelegt werden.
AnfrageGibt den durch die terminRaumId spezifizierten Raum des Jobs zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Raum-, sondern um den Anfrage- bzw. Buchungs-Datensatz eines Raums handelt. Entsprechend unterscheidet sich die terminRaumId von den IDs des Raums. Der Verweis auf den tatsächlichen Raum findet sich im Datensatz im Feld ZugehoerigkeitID.
AntwortenVerknüpft den genannten Job mit einem Raum. Hierbei kann neben der ZugehoerigkeitID (die technische ID eines Mitarbeiters, siehe api/stammdaten/room) und der Zugehoerigkeit (RO für Räume - wird automatisch vom System gefüllt) auch angegeben werden, ob der Raum verfügbar ist oder als gebucht markiert sein soll.
AnfrageAktualisiert den durch die terminRaumId definierten Raum bzw. die entsprechende Anfrage. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der Zugehoerigkeit (und der ZugehoerigkeitID) nicht möglich. Wenn ein Raum ausgetauscht werden soll muss er gelöscht und erneut angelegt werden.
AnfrageLöscht die durch die {terminRaumId} identifizierte Verknüpfung zwischen Job und Raum. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig. Beim Löschen dieser Verknüpfung wird die dahinterliegende Buchung automatisch gelöscht bzw. storniert.
AntwortenAktualisiert mehrere Räume bzw. die entsprechende Anfragen auf Basis eines übergebenen JSON-Arrays. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Zur Identifikation der einzelnen Objekte muss jedoch für jedes Objekt des Arrays zwingend das Attribut ID übergeben werden. Aus technischen Gründen ist eine Änderung der Zugehoerigkeit (und der ZugehoerigkeitID) nicht möglich. Wenn ein Raum ausgetauscht werden soll muss er gelöscht und erneut angelegt werden.
AnfrageGibt den durch die dispoentenID spezifizierten Disponenten des Jobs oder Projekts zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Mitarbeiter-, sondern um den Disponenten-Datensatz eines Mitarbeiters handelt. Entsprechend unterscheidet sich die disponentenID von den IDs der Mitarbeiter. Der Verweis auf den tatsächlichen Mitarbeiter findet sich im Datensatz im Feld MitarbeiterID.
AntwortenVerknüpft den genannten Job oder das Projekt mit einem Mitarbeiter als Disponent. Hierbei muss nur die MitarbeiterID (die technische ID eines Mitarbeiters, siehe api/stammdaten/mitarbeiter) angegeben werden. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageAktualisiert den durch die disponentenID definierten Disponent. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der TerminID bzw. ProjektID nicht möglich. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageLöscht die durch die {disponentenID} identifizierte Verknüpfung zwischen Job / Projekt und Mitarbeiter. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt den durch die projektleiterID spezifizierten Projektleiter des Jobs oder Projekts zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Mitarbeiter-, sondern um den Projektleiter-Datensatz eines Mitarbeiters handelt. Entsprechend unterscheidet sich die projektleiterID von den IDs der Mitarbeiter. Der Verweis auf den tatsächlichen Mitarbeiter findet sich im Datensatz im Feld MitarbeiterID.
AntwortenVerknüpft den genannten Job oder das Projekt mit einem Mitarbeiter als Projektleiter. Hierbei muss nur die MitarbeiterID (die technische ID eines Mitarbeiters, siehe api/stammdaten/mitarbeiter) angegeben werden. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageAktualisiert den durch die projektleiterID definierten Projektleiter. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der TerminID bzw. ProjektID nicht möglich. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageLöscht die durch die {projektleiterID} identifizierte Verknüpfung zwischen Job / Projekt und Mitarbeiter. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt den durch die ansprechpartnerID spezifizierten Kunden-Ansprechpartner des Jobs oder Projekts zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Ansprechpartner-, sondern um den Verbindungs-Datensatz eines Ansprechpartners handelt. Entsprechend unterscheidet sich die ansprechpartnerID von den IDs der Ansprechpartner. Der Verweis auf den tatsächlichen Ansprechpartner findet sich im Datensatz im Feld AnsprechpartnerID.
AntwortenVerknüpft den genannten Job oder das Projekt mit einem Ansprechpartner als Kunden-Ansprechpartner. Hierbei muss nur die AnsprechpartnerID (die technische ID eines Ansprechpartners, siehe api/stammdaten/kunde) angegeben werden. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageAktualisiert den durch die ansprechpartnerID definierten Kunden-Ansprechpartner. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der TerminID bzw. ProjektID nicht möglich. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageLöscht die durch die {ansprechpartnerID} identifizierte Verknüpfung zwischen Job / Projekt und Ansprechpartner. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt den durch die ansprechpartnerID spezifizierten Location-Ansprechpartner des Jobs zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Ansprechpartner-, sondern um den Verbindungs-Datensatz eines Ansprechpartners handelt. Entsprechend unterscheidet sich die ansprechpartnerID von den IDs der Ansprechpartner. Der Verweis auf den tatsächlichen Ansprechpartner findet sich im Datensatz im Feld AnsprechpartnerID.
AntwortenVerknüpft den genannten Job mit einem Ansprechpartner als Location-Ansprechpartner. Hierbei muss nur die AnsprechpartnerID (die technische ID eines Ansprechpartners, siehe api/stammdaten/location) angegeben werden. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageAktualisiert den durch die ansprechpartnerID definierten Location-Ansprechpartner. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der TerminID nicht möglich. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageLöscht die durch die {ansprechpartnerID} identifizierte Verknüpfung zwischen Job und Ansprechpartner. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt die Zusatzdaten des Typs zusatzdatentypID für das Hauptobjekt zurück.
AntwortenAktualisiert die Zusatzdaten des Typs zusatzdatentypID für das Hauptobjekt. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
AnfrageLöscht die Zusatzdaten des Typs {zusatzdatentypID} für das Hauptobjekt. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt die Kommentare zum übergeordneten Datensatz zurück.
AntwortenGibt den Kommentar mit der ID kommentarId zurück.
AntwortenLegt einen Kommentar zum übergeordneten Datensatz an. Sofern der Kommentar eine Antwort auf einen anderen Kommentar darstellt, kann die ID des ursprünglichen Kommentars im Feld ParentID übergeben werden. Optional kann zudem im Feld Dokument ein Anhang für den Kommentar übergeben werden.
AnfrageAktualisiert einen Kommentar zum übergeordneten Datensatz mit den angegebenen Werten.
AnfrageLöscht den Kommentar mit der ID {kommentarId} aus dem übergeordneten Datensatz. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenBietet Zugriff auf Projekte und deren Informationen
Gib das durch die projektId angeforderten Projekt zurück. Als projektId kann hierbei sowohl die technische ID als auch die ProjektID bzw. ProjektIDManuell angegeben werden.
Das Rückgabeobjekt enthält neben den eigentlichen Projekt-Informationen auch direkt Informationen zu vielen Unterelementen. So sind beispielsweise die Jobs und Unterjobs im Rückgabeobjekt enthalten.
AntwortenErzeugt ein Projekt auf Basis eines JSON-Objekts. Der Aufbau des JSON-Objekts ist hierbei zum großen Teil identisch mit dem JSON-Objekt, welches bei einem Aufruf von GET durch die API zurückgegeben wird, jedoch werden die Unterobjekte (Jobs, Unterjobs, etc.) nicht berücksichtigt. Um ein Projekt mit Jobs anzulegen ist somit zunächst ein Aufruf mit den Daten für das Projekt notwendig, anschließend können mir der zurückgegebenen technischen ID die Jobs und ggf. Unterjobs angelegt werden.
Um den Projekttyp, oder einen Kunden für das Projekt anzugeben bestehen im Rahmen dieses Aufrufs mehrere Möglichkeiten: über die Felder Typ, KundenID und Kunde kann jeweils die technische ID der entsprechenden Ressource übergeben werden. Alternativ ist es möglich, über die Felder Typ oder Kunde auch den Namen bzw. die Bezeichnung der Ressource zu übergeben, sofern diese im System eindeutig ist.
AnfrageAktualisiert das durch die projektId identifizierte Projekt mit den übergebenen Werten. Der Aufbau des JSON-Objekts ist hierbei zum großen Teil identisch mit dem JSON-Objekt, welches bei einem Aufruf von GET durch die API zurückgegeben wird, jedoch werden die Unterobjekte (Jobs und Unterjobs, etc.) nicht berücksichtigt. Hierbei sind grundsätzlich alle Werte optional, sodass Sie entweder einen per GET abgerufenen Job manipulieren oder ein neues Objekt mit nur einzelnen Werten erstellen und übergeben können.
Um den Projekttyp, oder einen Kunden für das Projekt anzugeben bestehen im Rahmen dieses Aufrufs mehrere Möglichkeiten: über die Felder Typ, KundenID und Kunde kann jeweils die technische ID der entsprechenden Ressource übergeben werden. Alternativ ist es möglich, über die Felder Typ oder Kunde auch den Namen bzw. die Bezeichnung der Ressource zu übergeben, sofern diese im System eindeutig ist.
AnfrageLöscht das durch die projektId identifizierte Projekt aus dem System. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenDurchsucht die Projekt-Datenbank nach Projekten mit dem Suchwort Suchtext.
Durch die Parameter Limit und Start lässt sich die maximale Anzahl sowie das Paging der Datensätze steuern. Der maximale Wert beträgt 100 Datensätze. Wurden keine Datensätze gefunden, so wird ein leeres JSON-Array zurückgegeben. Der optionale Parameter NurKuenftige erlaubt Ihnen, die Suche auf Projekte in der Zukunft einzuschränken (Standard) oder auch vergangene Projekte zu durchsuchen. Mit den ebenfalls optionalen Parametern DatumVon und DatumBis kann der Zeitraum beliebig eingeschränkt werden.
AnfrageGibt alle zu diesem Objekt gespeicherten Dokumente zurück. Hierbei werden jedoch nur die allgemeinen Informationen wie Dateiname und Typ zurückgegeben, um das Dokument selbst aufzurufen ist ein unabhängiger REST-Aufruf notwendig (siehe /dokument/).
AntwortenGibt das durch die docId spezifizierte Dokument zurück. Hierbei wird neben den Informationen wie Dateiname und Typ auch die Datei als base64-codierter String geliefert.
AntwortenSpeichert ein als base64-codierten String übergebenes Dokument zu dem genannten Job oder Projekt. Der JSON-Datensatz enthält hierbei lediglich drei Attribute: Dateiname, Dateiendung und Datei.
AnfrageAktualisiert das durch die docId definierte Dokument. Der JSON-Datensatz enthält wie auch der POST Request nur drei Attribute, wobei diese alle optional sind. Wenn Sie also nur den Dateinamen oder nur den Dateiinhalt ändern möchten, so müssen Sie die anderen Attribute nicht zwingend befüllen.
AnfrageLöscht das durch die {docId} identifizierte Dokument. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt den durch die dispoentenID spezifizierten Disponenten des Jobs oder Projekts zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Mitarbeiter-, sondern um den Disponenten-Datensatz eines Mitarbeiters handelt. Entsprechend unterscheidet sich die disponentenID von den IDs der Mitarbeiter. Der Verweis auf den tatsächlichen Mitarbeiter findet sich im Datensatz im Feld MitarbeiterID.
AntwortenVerknüpft den genannten Job oder das Projekt mit einem Mitarbeiter als Disponent. Hierbei muss nur die MitarbeiterID (die technische ID eines Mitarbeiters, siehe api/stammdaten/mitarbeiter) angegeben werden. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageAktualisiert den durch die disponentenID definierten Disponent. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der TerminID bzw. ProjektID nicht möglich. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageLöscht die durch die {disponentenID} identifizierte Verknüpfung zwischen Job / Projekt und Mitarbeiter. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt den durch die projektleiterID spezifizierten Projektleiter des Jobs oder Projekts zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Mitarbeiter-, sondern um den Projektleiter-Datensatz eines Mitarbeiters handelt. Entsprechend unterscheidet sich die projektleiterID von den IDs der Mitarbeiter. Der Verweis auf den tatsächlichen Mitarbeiter findet sich im Datensatz im Feld MitarbeiterID.
AntwortenVerknüpft den genannten Job oder das Projekt mit einem Mitarbeiter als Projektleiter. Hierbei muss nur die MitarbeiterID (die technische ID eines Mitarbeiters, siehe api/stammdaten/mitarbeiter) angegeben werden. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageAktualisiert den durch die projektleiterID definierten Projektleiter. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der TerminID bzw. ProjektID nicht möglich. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageLöscht die durch die {projektleiterID} identifizierte Verknüpfung zwischen Job / Projekt und Mitarbeiter. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt den durch die ansprechpartnerID spezifizierten Kunden-Ansprechpartner des Jobs oder Projekts zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Ansprechpartner-, sondern um den Verbindungs-Datensatz eines Ansprechpartners handelt. Entsprechend unterscheidet sich die ansprechpartnerID von den IDs der Ansprechpartner. Der Verweis auf den tatsächlichen Ansprechpartner findet sich im Datensatz im Feld AnsprechpartnerID.
AntwortenVerknüpft den genannten Job oder das Projekt mit einem Ansprechpartner als Kunden-Ansprechpartner. Hierbei muss nur die AnsprechpartnerID (die technische ID eines Ansprechpartners, siehe api/stammdaten/kunde) angegeben werden. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageAktualisiert den durch die ansprechpartnerID definierten Kunden-Ansprechpartner. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der TerminID bzw. ProjektID nicht möglich. Die Felder Nachname, Vorname und Telefon aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageLöscht die durch die {ansprechpartnerID} identifizierte Verknüpfung zwischen Job / Projekt und Ansprechpartner. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt die Zusatzdaten des Typs zusatzdatentypID für das Hauptobjekt zurück.
AntwortenAktualisiert die Zusatzdaten des Typs zusatzdatentypID für das Hauptobjekt. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
AnfrageLöscht die Zusatzdaten des Typs {zusatzdatentypID} für das Hauptobjekt. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt die Kommentare zum übergeordneten Datensatz zurück.
AntwortenGibt den Kommentar mit der ID kommentarId zurück.
AntwortenLegt einen Kommentar zum übergeordneten Datensatz an. Sofern der Kommentar eine Antwort auf einen anderen Kommentar darstellt, kann die ID des ursprünglichen Kommentars im Feld ParentID übergeben werden. Optional kann zudem im Feld Dokument ein Anhang für den Kommentar übergeben werden.
AnfrageAktualisiert einen Kommentar zum übergeordneten Datensatz mit den angegebenen Werten.
AnfrageLöscht den Kommentar mit der ID {kommentarId} aus dem übergeordneten Datensatz. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenBietet Zugriff auf eine Liste mit in einem bestimmten Zeitraum geänderten Jobs
Gibt die IDs zu geänderten Datensätzen zurück. Diese können anschließend über den jeweiligen Endpunkt vollständig abgerufen werden.
AnfrageBietet Zugriff auf Arbeitszeiten und deren Informationen
Gib die durch die zeitId angeforderte Arbeitszeit zurück.
AntwortenErzeugt eine Arbeitszeit auf Basis eines JSON-Objekts.
AnfrageAktualisiert die durch die zeitId identifizierte Arbeitszeit mit den übergebenen Werten.
AnfrageLöscht die durch die zeitId identifizierte Arbeitszeit aus dem System. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenDurchsucht die Datenbank nach Arbeitszeiten, die nach dem Zeitpunkt AenderungenSeit geändert wurden. Alternativ ist es möglich, durch die Verwendung von DatumVon und DatumBis die Arbeitszeiten auszulesen, die für einen bestimmten Zeitraum (zum Beispiel einen Monat) erfasst wurden.
Durch den Parameter MitarbeiterID lässt sich die Anfrage auf einen Mitarbeiter eingrenzen. Zudem lässt sich über Typ definieren, ob Vorgabe- oder Ist-Zeiten durchsucht werden sollen.
AnfrageBietet Zugriff auf Urlaube und Krankmeldungen und deren Informationen
Gibt den durch die urlaubId angeforderten Urlaub zurück.
AntwortenErzeugt einen Urlaub oder eine Krankmeldung auf Basis eines JSON-Objekts. Die Unterscheidung zwischen Urlaub und Krankmeldung erfolgt hierbei durch die KategorieID (siehe api/stammdaten/urlaubskategorien/).
AnfrageAktualisiert den durch die urlaubId identifizierten Urlaub mit den übergebenen Werten.
AnfrageLöscht den durch die zeitId identifizierten Urlaub aus dem System. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenDurchsucht die Datenbank nach Urlauben und Krankmeldungen, die nach dem Zeitpunkt AenderungenSeit geändert wurden. Alternativ ist es möglich, durch die Verwendung von DatumVon und DatumBis die Urlaube auszulesen, die für einen bestimmten Zeitraum (zum Beispiel einen Monat) erfasst wurden.
Durch den Parameter MitarbeiterID lässt sich die Anfrage auf einen Mitarbeiter eingrenzen.
AnfrageBietet Zugriff auf Fahrtenbuch-Einträge und deren Informationen
Gib den durch die driverslogId angeforderte Fahrtenbuch-Eintrag zurück.
AntwortenErzeugt einen Fahrtenbuch-Eintrag auf Basis eines JSON-Objekts.
AnfrageAktualisiert den durch die driverslogId identifizierten Fahrtenbuch-Eintrag mit den übergebenen Werten.
AnfrageLöscht den durch die driverslogId identifizierten Fahrtenbuch-Eintrag aus dem System. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenDurchsucht die Datenbank nach Fahrtenbuch-Einträgen. Hierbei können verschiedene Parameter zur Suche übergeben werden.
Die Parameter DriverID und VehicleID ermöglichen das Filtern nach Fahrer und Fahrzeug. Mit DateFrom und DateUntil kann der Zeitraum eingeschränkt werden und über Limit und Start lässt sich die Anzahl der Datensätze sowie der Start-Offet steuern.
AnfrageBietet Zugriff auf Aufgaben und deren Informationen
Gibt die durch die taskId angeforderte Aufgabe zurück.
AntwortenErzeugt eine Aufgabe auf Basis eines JSON-Objekts. Über die Felder Zugehoerigkeit und ZugehoerigkeitID kann gesteuert werden, welchem Objekt die Aufgabe zugewiesen werden soll. Mögliche Werte sind: A für Aufgaben, TL für Aufgabenlisten, T für Jobs und PR für Projekte. Wird Zugehoerigkeit leer gelassen, so wird eine Aufgabe in der Liste "neue Aufgaben" angelegt.
AnfrageAktualisiert die durch die taskId identifizierte Aufgabe mit den übergebenen Werten.
AnfrageLöscht die durch die taskId identifizierte Aufgabe aus dem System. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenDurchsucht die Aufgaben nach den angegebenen Suchkriterien.
In der Anfrage können verschiedene Parameter mitgegeben werden. Mit den Parametern zugehoerigkeit und zugehoerigkeitid lässt sich die Suche beispielsweise auf eine Aufgabenliste, einen Job oder ein Projekt sowie eine Hauptaufgabe einschränken. Wird keine zugehoerigkeit angegeben, gibt der Endpunkt nur diejenigen Aufgaben zurück, die keinem anderen Objekt zugeordnet sind.
Durch weitere Parameter lässt sich die Suche verfeinern: finished, dueToday, duePast, dueFuture und noDueDate sind boolesche Werte. Sind sie in der Anfrage angegeben, so wird die Liste entsprechend eingeschränkt. Mit den Parametern limit und start lässt sich steuern, wieviele Aufgaben ausgegeben werden sollen und bei welcher Aufgabe die Ausgabe startet (Paging).
Mit creator und responsible lässt sich die Suche auf einen Ersteller oder Bearbeiter einschränken. Möglich ist ein numerischer Wert oder eine Liste von numerischen Werten, wenn mehrere Personen gesucht werden sollen. Die ID ist jeweils die technische ID eines Mitarbeiters.
AnfrageGibt den durch die responsibleId spezifizierten Bearbeiter der Aufgabe zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Mitarbeiter-, sondern um den Bearbeiter-Datensatz eines Mitarbeiters handelt. Entsprechend unterscheidet sich die responsibleId von den IDs der Mitarbeiter. Der Verweis auf den tatsächlichen Mitarbeiter findet sich im Datensatz im Feld BearbeiterID.
AntwortenVerknüpft die genannte Aufgabe mit einem Mitarbeiter als Bearbeiter. Hierbei muss nur die BearbeiterID (die technische ID eines Mitarbeiters, siehe api/stammdaten/mitarbeiter) angegeben werden. Die Felder Nachname, Vorname und Name aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageAktualisiert den durch die responsibleId definierten Bearbeiter. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der AufgabenID nicht möglich. Die Felder Nachname, Vorname und Name aus der Antwort dürfen hierbei nicht angegeben werden, Sie werden lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageLöscht die durch die {responsibleId} identifizierte Verknüpfung zwischen Aufgabe und Mitarbeiter. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt alle zu diesem Objekt gespeicherten Dokumente zurück. Hierbei werden jedoch nur die allgemeinen Informationen wie Dateiname und Typ zurückgegeben, um das Dokument selbst aufzurufen ist ein unabhängiger REST-Aufruf notwendig (siehe /dokument/).
AntwortenGibt das durch die docId spezifizierte Dokument zurück. Hierbei wird neben den Informationen wie Dateiname und Typ auch die Datei als base64-codierter String geliefert.
AntwortenSpeichert ein als base64-codierten String übergebenes Dokument zu dem genannten Job oder Projekt. Der JSON-Datensatz enthält hierbei lediglich drei Attribute: Dateiname, Dateiendung und Datei.
AnfrageAktualisiert das durch die docId definierte Dokument. Der JSON-Datensatz enthält wie auch der POST Request nur drei Attribute, wobei diese alle optional sind. Wenn Sie also nur den Dateinamen oder nur den Dateiinhalt ändern möchten, so müssen Sie die anderen Attribute nicht zwingend befüllen.
AnfrageLöscht das durch die {docId} identifizierte Dokument. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt die Kommentare zum übergeordneten Datensatz zurück.
AntwortenGibt den Kommentar mit der ID kommentarId zurück.
AntwortenLegt einen Kommentar zum übergeordneten Datensatz an. Sofern der Kommentar eine Antwort auf einen anderen Kommentar darstellt, kann die ID des ursprünglichen Kommentars im Feld ParentID übergeben werden. Optional kann zudem im Feld Dokument ein Anhang für den Kommentar übergeben werden.
AnfrageAktualisiert einen Kommentar zum übergeordneten Datensatz mit den angegebenen Werten.
AnfrageLöscht den Kommentar mit der ID {kommentarId} aus dem übergeordneten Datensatz. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenBietet Zugriff auf Aufgabenlisten und deren Informationen
Gibt die durch die tasklistId angeforderte Liste zurück.
AntwortenErzeugt eine Liste auf Basis eines JSON-Objekts. Über die Felder FolderID und Position kann gesteuert werden, wo die Liste eingeordnet werden soll.
AnfrageAktualisiert die durch die tasklistId identifizierte Liste mit den übergebenen Werten.
AnfrageLöscht die durch die tasklistId identifizierte Liste aus dem System. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt alle zu dieser Liste gespeicherten Aufgaben zurück. Über die Anfrage lässt sich die Liste auf verschiedene Kriterien einschränken (siehe /api/task/suche für Details zu den Kriterien).
AnfrageGibt den durch die participantId spezifizierten Teilnehmer der Aufgabenliste zurück. Hierbei ist zu beachten, dass es sich hier nicht um den eigentlichen Mitarbeiter-, sondern um den Teilnehmer-Datensatz eines Mitarbeiters handelt. Entsprechend unterscheidet sich die participantId von den IDs der Mitarbeiter. Der Verweis auf den tatsächlichen Mitarbeiter findet sich im Datensatz im Feld ParticipantID. Über das Feld ParticipantType kann zudem anstelle eines Mitarbeiters auch eine Benutzergruppe (G) oder eine Abteilung (DP) festgelegt werden.
AntwortenVerknüpft die genannte Aufgabenliste mit einem Mitarbeiter (alternativ: Benutzergruppe oder Abteilung) als Teilnehmer. Hierbei muss nur die ParticipantID (die technische ID eines Mitarbeiters, siehe api/stammdaten/mitarbeiter) sowie der ParticipantType angegeben werden. Das Feld Name aus der Antwort darf hierbei nicht angegeben werden, es wird lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageAktualisiert den durch die participantId definierten Teilnehmer. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen. Aus technischen Gründen ist eine Änderung der TasklistID nicht möglich. Das Feld Name aus der Antwort darf hierbei nicht angegeben werden, es wird lediglich in der Antwort angereichert, um einen schnellen Zugriff zu ermöglichen.
AnfrageLöscht die durch die {participantId} identifizierte Verknüpfung zwischen Aufgabenliste und Teilnehmer. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenBietet Zugriff auf Ordner für Aufgabenlisten und deren Informationen
Gibt den durch die folderId angeforderten Ordner zurück.
AntwortenErzeugt einen Ordner auf Basis eines JSON-Objekts. Über die Felder ParentID und Position kann gesteuert werden, wo der Ordner eingeordnet werden soll.
AnfrageAktualisiert den durch die folderId identifizierten Ordner mit den übergebenen Werten.
AnfrageLöscht den durch die folderId identifizierten Ordner aus dem System. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenErzeugt eine Liste aller Aufgabenlisten und Ordner des Benutzers.
Gib eine Liste aller Ordner und Aufgabenlisten zurück. Für jeden Ordner werden zudem die untergeordneten Order Folders und Aufgabenlisten Tasklists zurückgegeben.
AntwortenBietet Zugriff auf die Daten des aktuell angemeldeten Benutzers
Gibt den aktuell angemeldeten Benutzer zurück.
AntwortenAktualisiert den aktuell angemeldeten Benutzer. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
AnfrageGibt das Profilbild für diese Ressource zurück. Hierbei wird die URL des Profilbilds geliefert.
AntwortenSpeichert ein als base64-codierten String übergebenes Profilbild zu der entsprechenden Ressource. Der JSON-Datensatz enthält hierbei lediglich ein Attribut: Image.
AnfrageAktualisiert das Profilbild der Ressource. Der JSON-Datensatz enthält wie auch der POST Request nur ein Attribut.
AnfrageLöscht das Profilbild für diese Ressource. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt den durch die ansprechpartnerID spezifizierten Ansprechpartner zurück.
AntwortenLegt den durch das JSON-Objekt definierten Ansprechpartner an.
AnfrageAktualisiert den durch die ansprechpartnerID definierten Ansprechpartner. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
AnfrageLöscht den durch die {ansprechpartnerID} identifizierten Ansprechpartner. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt alle hinterlegten Ansprechpartner zurück.
AntwortenGibt ein Mitarbeiterdokument zurück.
AntwortenLegt ein Mitarbeiterdokument an.
AnfrageGibt eine Liste aller verfügbaren Mitarbeiterdokumenten zurück.
AntwortenDurchsucht die Datenbank nach Mitarbeiterdokumenten mit bestimmten Suchkriterien.
AnfrageBietet Zugriff auf die für Mitarbeiter, Freelancer und Dienstleister hinterlegten Zertifikate.
Gibt das Zertifikat mit der ID certificateId zurück.
AntwortenLegt ein Zertifikat an. Im Feld KategrieID ist entweder eine valide Zertifikat-Kategorie (siehe api/stammdaten/zertifikatkategorie) oder alternativ -1 zu hinterlegen. Wird -1 hinterlegt, so muss das Feld Bezeichnung zwingend gefüllt werden. Optional kann zudem im Feld Document ein Anhang für das Zertifikat übergeben werden.
AnfrageAktualisiert ein Zertifikat mit den angegebenen Werten.
AnfrageLöscht das Zertifikat mit der ID {certificateId}. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenDurchsucht die Datenbank nach Zertifikaten mit bestimmten Suchkriterien.
AnfrageBietet Zugriff auf die im elektronischen Verbandbuch gespeicherten Arbeitsunfälle.
Gibt den Arbeitsunfall mit der ID accidentId zurück.
AntwortenLegt einen Arbeitsunfall an.
AnfrageAktualisiert einen Arbeitsunfall mit den angegebenen Werten.
AnfrageLöscht den Arbeitsunfall mit der ID {accidentId}. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenDurchsucht die Datenbank nach Arbeitsunfälle mit bestimmten Suchkriterien.
AnfrageBietet Zugriff auf die im System hinterlegten Dienstanweisungen und Bestätigungen.
Gibt die Dienstanweisung mit der ID instructionId zurück.
AntwortenDurchsucht die Datenbank nach Dienstanweisungen mit bestimmten Suchkriterien. Über den Parameter searchAll kann angegeben werden, ob alle Anweisungen oder nur die für den angemeldeten Benutzer relevanten Anweisungen durchsucht werden sollen. ACHTUNG: abhängig von diesem Parameter ändert sich das Rückgabeobjekt des Endpunkts.
AnfrageGibt die Zustimmung oder Ablehnung zur Dienstanweisung für den aktuell angemeldeten Benutzern zurück.
AntwortenLegt eine Zustimmung oder Ablehnung zur Dienstanweisung an.
AnfrageBietet Zugriff auf Mitarbeiter und deren Informationen
Gibt den durch die mitarbeiterId angeforderten Mitarbeiter zurück.
AntwortenLegt den durch das JSON-Objekt definierten Mitarbeiter an. Hierbei kann bei Bedarf auch das Attribut Passwort mitgegeben werden, in diesem Fall steht der neue Benutzer direkt zum Login zur Verfügung.
AnfrageAktualisiert den durch die mitarbeiterId definierten Mitarbeiter. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
AnfrageLöscht den durch die mitarbeiterId definierten Mitarbeiter. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenDurchsucht die Mitarbeiter-Datenbank nach Datensätzen mit dem Suchwort Suchtext. Über den Wert Suchfelder kann angegeben werden, welche Felder der Datensätze durchsucht werden sollen (Standard: Vorname, Nachname, Name).
Durch die Parameter Limit und Start lässt sich die maximale Anzahl sowie das Paging der Datensätze steuern. Der maximale Wert beträgt 100 Datensätze. Wurden keine Datensätze gefunden, so wird ein leeres JSON-Array zurückgegeben.
AnfrageWeist dem Benutzer die durch ID oder Name definierte Benutzergruppe zu.
AnfrageEntfernt die durch die benutzergruppenId identifizierte Benutzergruppe vom betreffenden Benutzer.
AntwortenGibt die durch die kategorieId angeforderte Kategorie zurück. Die Kategorie enthält im Attribut KategorieID einen Verweis auf eine Mitarbeiter-Kategorie (siehe api/stammdaten/kategorie).
AntwortenWeist dem Benutzer die durch ID oder Bezeichnung definierte Kategorie zu.
AnfrageAktualisiert die durch die kategorieId definierte Kategorie. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
AnfrageEntfernt die durch die kategorieId identifizierte Kategorie vom betreffenden Benutzer.
AntwortenGibt die Zusatzdaten des Typs zusatzdatentypID für das Hauptobjekt zurück.
AntwortenAktualisiert die Zusatzdaten des Typs zusatzdatentypID für das Hauptobjekt. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
AnfrageLöscht die Zusatzdaten des Typs {zusatzdatentypID} für das Hauptobjekt. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenGibt ein Mitarbeiterdokument zurück.
AntwortenLegt ein Mitarbeiterdokument an.
AnfrageGibt eine Liste aller verfügbaren Mitarbeiterdokumenten zurück.
AntwortenDurchsucht die Datenbank nach Mitarbeiterdokumenten mit bestimmten Suchkriterien.
AnfrageBietet Zugriff auf Freelancer und deren Informationen
Gibt den durch die mitarbeiterId angeforderten Freelancer zurück.
AntwortenLegt den durch das JSON-Objekt definierten Freelancer an. Hierbei kann bei Bedarf auch das Attribut Passwort mitgegeben werden, in diesem Fall steht der neue Benutzer direkt zum Login zur Verfügung.
AnfrageAktualisiert den durch die freelancerId definierten Freelancer. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
AnfrageLöscht den durch die freelancerId definierten Freelancer. Hierfür sind keine weiteren Parameter bzw. keine erweitere JSON-Anfrage notwendig.
AntwortenDurchsucht die Freelancer-Datenbank nach Datensätzen mit dem Suchwort Suchtext. Über den Wert Suchfelder kann angegeben werden, welche Felder der Datensätze durchsucht werden sollen (Standard: Vorname, Nachname, Name).
Durch die Parameter Limit und Start lässt sich die maximale Anzahl sowie das Paging der Datensätze steuern. Der maximale Wert beträgt 100 Datensätze. Wurden keine Datensätze gefunden, so wird ein leeres JSON-Array zurückgegeben.
AnfrageWeist dem Benutzer die durch ID oder Name definierte Benutzergruppe zu.
AnfrageEntfernt die durch die benutzergruppenId identifizierte Benutzergruppe vom betreffenden Benutzer.
AntwortenGibt die durch die kategorieId angeforderte Kategorie zurück. Die Kategorie enthält im Attribut KategorieID einen Verweis auf eine Mitarbeiter-Kategorie (siehe api/stammdaten/kategorie).
AntwortenWeist dem Benutzer die durch ID oder Bezeichnung definierte Kategorie zu.
AnfrageAktualisiert die durch die kategorieId definierte Kategorie. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
AnfrageEntfernt die durch die kategorieId identifizierte Kategorie vom betreffenden Benutzer.
AntwortenGibt die Zusatzdaten des Typs zusatzdatentypID für das Hauptobjekt zurück.
AntwortenAktualisiert die Zusatzdaten des Typs zusatzdatentypID für das Hauptobjekt. Hierbei sind alle Attribute optional, sodass Sie für die Änderung einzelner Attribute auch nur diese übergeben müssen.
Anfrage