Keine Bearbeitungszusammenfassung |
Keine Bearbeitungszusammenfassung Markierung: 2017-Quelltext-Bearbeitung |
||
| Zeile 1: | Zeile 1: | ||
Diese [[Programmfunktion]] dient dazu Informationen aus einem [[Automatischer Konto-Report-Export|automatischen Konto-Report-Export]] mittels [[Webservice]] < | Diese [[Programmfunktion]] dient dazu Informationen aus einem [[Automatischer Konto-Report-Export|automatischen Konto-Report-Export]] mittels [[Webservice]] Fremdsystemen zur maschinellen Weiterverarbeitung zur Verfügung zu stellen. | ||
== Ausgangssituation == | |||
=== Voraussetzungen === | |||
{{webservice_prerequisites|Intern:Webservice Tagesinformationen Aktivierung}} | |||
* <code>/EmployeeDayIntervals</code> | |||
=== Formatierung der Anfrage === | |||
Die Daten werden dem Webservice '''in der URL kodiert''' als '''GET'''-Argumentübertragung übergeben. | |||
Ein Datum wird immer als <code>DD.MM.YYYY</code> übertragen. | |||
==== 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: | |||
'''/EmployeeDayIntervals''' | |||
[?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>id</code> || Zeichenkette || Eine Personalnummer | |||
|- | |||
| <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 | |||
|} | |||
=== Formatierung der Ausgabe === | |||
Tagesinformation im [https://www.json.org/ JSON-Format] UTF8 codiert. Das JSON-Objekt hat folgendes [https://json-schema.org/ JSON-Schema]: | |||
== Ausgangssituation == | == Ausgangssituation == | ||
Version vom 25. April 2023, 09:50 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 Webservice muss das richtige Plugin konfiguriert sein.
Das Webservice stellt dann folgende Zugriffspfade zur Verfügung:
/EmployeeDayIntervals
Formatierung der Anfrage
Die Daten werden dem Webservice in der URL kodiert als GET-Argumentübertragung übergeben.
Ein Datum wird immer als DD.MM.YYYY übertragen.
Schema für URL-Kodierung
Der Prozent-Encodierte Query-String der URL muss folgendes Format haben. Parameter in eckigen Klammern sind optional:
/EmployeeDayIntervals [?allEmployees=] [&id=] [&planCode=] [&resourcesBson=] [&begin=] [&end=] [&allstates=]
| Parameter | Wertebereich | Beschreibung |
|---|---|---|
allEmployees |
true oder false |
Wenn true, gesamtes Personal im Zeitbereich
|
id |
Zeichenkette | Eine Personalnummer |
planCode |
Zeichenkette | Kurzcode eines Plans |
resourcesBson |
Zeichenkette | JSON-String: eine Zusammenfassung von Plan Kurzzeichen und Personalnummern zum Beispiel: resourcesBson={"employeeIDs":["E1","E2","E3"],"planCodes":["P1","P2","P3"]}
|
begin |
Datum | Beginn des abzufragenden Zeitbereichs, falls nicht angegeben Heute |
end |
Datum | Ende des abzufragenden Zeitbereichs, falls nicht angegeben Morgen |
allstates |
true oder false |
Wenn true, Statusdaten für alle aktuellen Status: Planung -> Planung, Ist -> Planung und Ist
|
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!
