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

Version vom 3. Mai 2023, 16:57 Uhr

Das Wt-Webservice - Automatischer Konto-Report-Export ist eine Programmfunktion, die es ermöglicht, Dateien, welche durch einen automatischen Konto-Report-Export erzeugt wurden, abzurufen.

Diese Dateien können durch Fremdsysteme weiterverarbeitet werden.

Ausgangssituation

Voraussetzungen

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

Das Webservice stellt 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

Parameter	Wertebereich	Beschreibung
`<Dateiname>`	Zeichenkette	Bezeichnung des Konto-Reports
`<Dateiendung>`	Zeichenkette	Laut Exporteinstellungen
`<WebApiServerKey>`	Zeichenkette	Sicherer Aufruf

Die URL ohne WebAPIkey muss folgendes Format aufweisen:

/<Dateiname>.<Dateiendung>

Die URL mit WebAPIkey muss folgendes Format aufweisen:

/<Dateiname>.<Dateiendung>?WebApiServerKey=<1234-1234-1234-1234-1234>

Formatierung der Ausgabe

Eine Datei im Format der hinterlegten Konto-Report Exporteinstellungen.

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

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.

Beispiel

Es sollen folgenden aktuelle Parameter und Zeitkonten über eine URL abrufbar sein:

Zuname
Vorname
Personalnummer
Zeitausgleich
DRZ-Bilanz Vorschau gesamt

Fußnoten

Issue 8011

@@ Zeile 16: / Zeile 16: @@
 ==== Schema für URL-Kodierung ====
-Die URL muss folgendes Format haben:
- '''/<Dateiname>.<Dateiendung>'''
 {| class="wikitable" style=""
-! Parameter !! Wertebereich !! Beschreibung
+!Parameter!!Wertebereich!!Beschreibung
 |-
-| <code><Dateiname></code> || Zeichenkette ||[[Konto-Report#Konto-Report anlegen|Bezeichnung des Konto-Reports]]
+|<code><Dateiname></code>||Zeichenkette||[[Konto-Report#Konto-Report anlegen|Bezeichnung des Konto-Reports]]
 |-
-|<code><Dateiendung></code>||Zeichenkette ||[[Konto-Report-Export#Funktionsbeschreibung|Laut Exporteinstellungen]]
+|<code><Dateiendung></code>||Zeichenkette||[[Konto-Report-Export#Funktionsbeschreibung|Laut Exporteinstellungen]]
+|-
+|<code><WebApiServerKey></code>||Zeichenkette||[[Webservice_Authorization|Sicherer Aufruf]]
 |}
-=== Formatierung der Ausgabe===
+Die URL ohne WebAPIkey muss folgendes Format aufweisen:
+ '''/<Dateiname>.<Dateiendung>'''
+Die URL mit WebAPIkey muss folgendes Format aufweisen:
+ '''/<Dateiname>.<Dateiendung>?WebApiServerKey=<1234-1234-1234-1234-1234>'''
+===Formatierung der Ausgabe ===
 Eine Datei im Format der hinterlegten Konto-Report Exporteinstellungen.