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

Zeile 1: Zeile 1:
[[Bild:ApothekeralexMiraculix.png|right|300px]]
Diese [[Programmfunktion]] dient dazu Informationen aus einem [[Automatischer Konto-Report-Export|Automatische Konto-Report-Export]] für eine Bit-Factory-fremde Software zu Verfügung zu stellen.
'''<big>ACHTUNG: Artikel ist in Arbeit und wird laufend aktualisiert...</big>'''


Der [[Automatischer Konto-Report-Export|Automatische Konto-Report-Export]] lässt, mittels einer Webservice-Schnittstelle, Informationen aus einem [[Konto-Report]] über eine URL aufrufen. Diese [[Programmfunktion]] ermöglicht es Informationen aus einem Konto-Report an eine Bit-Factory-fremde Software zu übermitteln.
Dabei wird das Ergebnis eines [[Konto-Report|Konto-Reports]] mittels [[Webservice]] über eine URL aufgerufen.  
 
Die Daten können in unverschlüsselter oder auch in [[Webservice Authorization|verschlüsselter]] Form bereitgestellt werden.


==<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Aufruf_der_Funktion">Aufruf der Funktion</span>==
==<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Aufruf_der_Funktion">Aufruf der Funktion</span>==
Zeile 11: Zeile 8:


===Unverschlüsselter Aufruf===
===Unverschlüsselter Aufruf===
'''Aufbau der URL:'''
[http://localhost:8080/Personalwolke.json http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung]
[http://localhost:8080/Personalwolke.json http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung]
'''Beispiel:'''


[http://80.122.54.250:8080/Zeitguthabenstände http://52.28.12.244:8080/Zeitguthaben.json]
[http://80.122.54.250:8080/Zeitguthabenstände http://52.28.12.244:8080/Zeitguthaben.json]


===Verschlüsselter Aufruf===
===Verschlüsselter Aufruf===
'''Aufbau der URL:'''
[http://localhost:8080/Personalwolke.json http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung&WebApiServerKey=Wert]
[http://localhost:8080/Personalwolke.json http://Server-IP-Adresse:webServerPort/BezeichnungKontoReport.Dateiendung&WebApiServerKey=Wert]
'''Beispiel:'''


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


===<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Abgreifen_der_Steuerdaten">Abgreifen der Steuerdaten</span>===
===<span class="mw-headline" style="box-sizing: border-box; font-family: Montserrat, serif;" id="Abgreifen_der_Steuerdaten">Abgreifen der Steuerdaten</span>===
Steuerdaten für die Schnittstelle sind beim [[Automatischer Konto-Report-Export#Anlage Konto-Report|Konto-Report]] und beim [[Automatischer Konto-Report-Export#Anlage automatischer Konto-Report Export|Automatischen Konto-Report-Export]] zu finden.
Die Hinterlegung der Steuerdaten für die Schnittstelle wird beim [[Automatischer Konto-Report-Export#Anlage Konto-Report|Konto-Report]] detailliert beschrieben.
 
Sollte man sich dazu entschließen die Schnittstelle zusätzlich verschlüsseln zu wollen, sind weitere Steuerdaten in der Gruppe [[Webservice Authorization|WebApiServer Einstellungen in den Systemeinstellungen]] zu hinterlegen.


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

Version vom 25. April 2023, 08:08 Uhr

Diese Programmfunktion dient dazu Informationen aus einem Automatische Konto-Report-Export für eine Bit-Factory-fremde Software zu Verfügung zu stellen.

Dabei wird das Ergebnis eines Konto-Reports mittels Webservice über eine URL aufgerufen.

Aufruf der Funktion

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

Aufruf über URL
Webservice - Automatischer Konto-Report-Export.png

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

Abgreifen der Steuerdaten

Die Hinterlegung der Steuerdaten für die Schnittstelle wird beim Konto-Report detailliert beschrieben.

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

Beispiele

Es sollen folgende Informationen über die Schnittstelle abrufbar sein:

  • Zuname
  • Vorname
  • Personalnummer
  • Zeitausgleichskonsum
  • Fortbildungdauer in Stunden

Konkrete Anwendungsfälle

Es sollen folgende tagesaktuelle Informationen jederzeit verschlüsselt über die Schnittstelle abrufbar sein.

  • Zuname
  • Vorname
  • Personalnummer
  • Urlaub Rest in Tagen
  • Krankenstandsdauer in Stunden
  • DRZ +/- Übertrag

Fußnoten