diff --git a/AddOn/Calender_Office365_User/Fehlzeitenimport/readme.md b/AddOn/Calender_Office365_User/Fehlzeitenimport/readme.md index 24e729ea..67f28967 100644 --- a/AddOn/Calender_Office365_User/Fehlzeitenimport/readme.md +++ b/AddOn/Calender_Office365_User/Fehlzeitenimport/readme.md @@ -6,6 +6,7 @@ Die Zeiterfassungssoftware ZeusX bitet eine WebAPI Schnittstelle an. - PHP 7.x oder höher - cURL-Erweiterung +- REST WebAPI Client für die Einrichtung - Webserver mit HTTPS-Unterstützung beim ZeusX - Softwarelizenz für den Export von Kalenderfehlzeiten über WebAPI @@ -22,7 +23,49 @@ Die Zeiterfassungssoftware ZeusX bitet eine WebAPI Schnittstelle an. - Systemeinstellungen >> API Web-Service >> Datenschutzeinstellung: Auf zusätzliche Client Autorisierung wird verzichtet - Erstellung des (Bearer) Token über `https:///Environment/Account/Token.aspx` mit dem Schnittstelle `webapi` und dem ZeusX Login -3. **Abfrage testen und vorrichten** - - Installation von einem REST WebAPI Client notwendig (z.B. Curl, Bruno oder Postman) - - 1. Abfrage aller Exporte aus der Zeiterfassungssoftware ZeusX mit einem +3. **Abfrage testen** + - Abfrage aller Exporte aus der Zeiterfassungssoftware ZeusX mit einem GET Request: + ``` + curl --request GET \ + --url https:////api/export/ \ + --header 'authorization: ' + ``` + Hier wird dann ein JSON zurückgegeben mit einer Liste aller in der Zeiterfassungssoftware ZeusX definierten Exportdefinitionen + Zur Abfrage wird die ObjektId aus dem JSON benötigt. + + - Abfrage aller Organisationseinhgeiten bzw. Abteilungen per GET Request, die ine der Zeiterfassungssoftware ZeusX angelegt sind: + ``` + curl --request GET \ + --url https:////api/organization/ \ + --header 'authorization: ' + ``` + Hier wird wieder die ObjektId aus dem zurück gegebenen JSON der jeweiligen OE benötigt. + + - Beantragung der Erstellung und zusammenfügen der Daten aus der Zeiterfassungssoftware+ ZeusX per POST Request: + ``` + curl --request POST \ + --url https:////api/export \ + --header 'authorization: ' \ + --header 'content-type: application/json' \ + --data '{ + "ExportDefinition":"", + "organizationUnit":"", + "DateFrom":"", + "DateUntil":"" + }' + ``` + Hier wird ein reiner Text zurück gegeben mit einer GUID die für die Abfrage der Daten notwendig ist. + + - Abfrage der Exportdaten die beantragt worden sind per GET Request: + ``` + curl --request GET \ + --url https:////api/export/ \ + --header 'authorization: ' + ``` + Hier kann die Antwort entweder die zu erwartenden Daten sein, oder folgendses JSON, was dann bedeutet das die Erstellung der Daten aktuell noch andauert: + ``` + { + "Result":"JobPending", + "Message":"" + } + ```