Webservice - Automatischer Konto-Report-Export: Unterschied zwischen den Versionen

Version vom 25. April 2023, 10:03 Uhr

Diese Programmfunktion dient dazu Informationen aus einem automatischen Konto-Report-Export mittels Webservice Fremdsystemen zur maschinellen Weiterverarbeitung zur Verfügung zu stellen.

Ausgangssituation

Voraussetzungen

Neben den Voraussetzungen für den Betrieb eines Wt-Webservice muss ein Automatischer-Konto-Report-Export konfiguriert sein.

Das Webservice stellt dann für jede Exportierte Datei einen Zugriffspfad zur Verfügung

Formatierung der Anfrage

Die Daten werden dem Webservice als GET-Argumentübertragung übergeben.

Schema für URL-Kodierung

Die URL muss folgendes Format haben:

/<Dateiname>.<Dateiendung>

Parameter	Wertebereich	Beschreibung
`<Dateiname>`	Zeichenkette
`<Dateiendung>`	Zeichenkette

Formatierung der Ausgabe

Tagesinformation im JSON-Format UTF8 codiert. Das JSON-Objekt hat folgendes JSON-Schema:

Ausgangssituation

Voraussetzungen

Das Webservice baut auf die Programmfunktionen Webservice Tagesinformationen bzw. Webservice Personalstammdaten Export auf und setzt voraus, dass Alex^® von Bit Factory gehostet wird.

Aufruf der Funktion

Ist die Datenbank laut Anforderung eingerichtet, so kann man einen automatischen Konto-Report-Export unverschlüsselt wie folgt aufrufen:

Aufruf über URL

Unverschlüsselter Aufruf

Aufbau der URL:

http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung

Beispiel:

http://52.28.12.244:8080/Zeitguthaben.json

Verschlüsselter Aufruf

Aufbau der URL:

http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung&WebApiServerKey=Wert

Beispiel:

http://52.28.12.244:8080/Zeitguthaben.json&WebApiServerKey=1234-1234-1234-1234-1234

Funktionsbeschreibung

Das Webservice - Automatischer Konto-Report-Export ist eine Programmfunktion zur Abfrage von Tagesinformationen pro Personal und Zeitbereich sowie zur Abfrage von Personalstammdaten für einen Zeitbereich.

Abgreifen der Steuerdaten

Die Hinterlegung der Steuerdaten wird beim Anlegen eines automatischen Konto-Report-Export detailliert beschrieben.

ACHTUNG: Es dürfen beliebig viele Spalten im Konto-Report hinzugefügt, jedoch keine Spalten entfernt werden!

Fußnoten

Issue 8011

@@ Zeile 15: / Zeile 15: @@
 ==== Schema für URL-Kodierung ====
-Der [https://de.wikipedia.org/wiki/URL-Encoding Prozent-Encodierte] [https://de.wikipedia.org/wiki/Query-String Query-String] der URL muss folgendes Format haben. Parameter in eckigen Klammern sind optional:
+Die URL muss folgendes Format haben:
-  '''/EmployeeDayIntervals'''
+  '''/<Dateiname>.<Dateiendung>'''
- [?allEmployees=]
- [&id=]
- [&planCode=]
- [&resourcesBson=]
- [&begin=]
- [&end=]
- [&allstates=]
 {| class="wikitable" style=""
 ! Parameter !! Wertebereich !! Beschreibung
 |-
-| <code>allEmployees</code> || <code>true</code> oder <code>false</code> || Wenn <code>true</code>, gesamtes Personal im Zeitbereich
+| <code><Dateiname></code> || Zeichenkette ||
 |-
-| <code>id</code> || Zeichenkette || Eine Personalnummer
+| <code><Dateiendung></code> || Zeichenkette ||
-|-
-| <code>planCode</code> || Zeichenkette || Kurzcode eines Plans
-|-
-| <code>resourcesBson</code> || Zeichenkette || JSON-String: eine Zusammenfassung von Plan Kurzzeichen und Personalnummern zum Beispiel: <code>resourcesBson={"employeeIDs":["E1","E2","E3"],"planCodes":["P1","P2","P3"]}</code>
-|-
-| <code>begin</code> || Datum || Beginn des abzufragenden Zeitbereichs, falls nicht angegeben '''Heute'''
-|-
-| <code>end</code> || Datum || Ende des abzufragenden Zeitbereichs, falls nicht angegeben '''Morgen'''
-|-
-| <code>allstates</code> || <code>true</code> oder <code>false</code> || Wenn <code>true</code>, Statusdaten für alle aktuellen Status: Planung -> Planung, Ist -> Planung und Ist
 |}