Keine Bearbeitungszusammenfassung |
|||
| Zeile 5: | Zeile 5: | ||
=== Voraussetzungen === | === Voraussetzungen === | ||
Es müssen die Voraussetzungen für den Betrieb des [[Intern:Bfx.Alex.UI.Web.dll|WebUI-Webservice]] erfüllt sein sein. | * Es müssen die Voraussetzungen für den Betrieb des [[Intern:Bfx.Alex.UI.Web.dll|WebUI-Webservice]] erfüllt sein sein. | ||
* Es muss ein Benutzer mit den gewünschten Druckeinstellungen konfiguriert werden. | |||
**<code>Systemeinstellungen: Druck-Einstellungen: Benutzer für Webservice Ausdruck von Monatsplan</code> | |||
* Der Benutzer muss mindestens die Rechte '''Dienstplan lesen''' besitzen. | |||
{{AlexBild|Ausdruck Benutzer|[[Datei:Dienstplan_PDF.PNG]]}} | |||
=== Formatierung der Anfrage=== | |||
=== Formatierung der Anfrage === | |||
Die Daten werden dem Webservice '''in der URL kodiert''' als '''GET'''-Argumentübertragung übergeben. | Die Daten werden dem Webservice '''in der URL kodiert''' als '''GET'''-Argumentübertragung übergeben. | ||
| Zeile 19: | Zeile 17: | ||
Ein Datum wird immer als <code>DD.MM.YYYY</code> übertragen. | Ein Datum wird immer als <code>DD.MM.YYYY</code> übertragen. | ||
==== Schema für URL-Kodierung ==== | ====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: | 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: | ||
| Zeile 28: | Zeile 26: | ||
[&date=] | [&date=] | ||
{| class="wikitable" | {| class="wikitable alex-blue" | ||
! Parameter !! Wertebereich !! Beschreibung | !Parameter!!Wertebereich!!Beschreibung | ||
|- | |- | ||
| <code>planCode</code> || Zeichenkette || Kurzzeichen einer Planungseinheit | |<code>planCode</code>||Zeichenkette||Kurzzeichen einer Planungseinheit | ||
|- | |- | ||
| <code>employeeId</code> || Datum || Eine Personalnummer, die '''Planungseinheit''' ergibt sich aus der '''Stammzuteilung''' | |<code>employeeId</code>||Datum||Eine Personalnummer, die '''Planungseinheit''' ergibt sich aus der '''Stammzuteilung''' | ||
|- | |- | ||
| <code>date</code> || Datum || Datum des Monats des gewünschten Stundennachweises, wenn nicht angegeben '''Heute''' | |<code>date</code>||Datum||Datum des Monats des gewünschten Stundennachweises, wenn nicht angegeben '''Heute''' | ||
|} | |} | ||
Beispiel: | Beispiel: | ||
* <code><nowiki>http://192.168.0.100:8080/AlexPrintPlanPeriod?date=10.06.2023&employeeId=123</nowiki></code> | *<code><nowiki>http://192.168.0.100:8080/AlexPrintPlanPeriod?date=10.06.2023&employeeId=123</nowiki></code> | ||
===Minimaler Status für Webservice-Ausdruck von Dienstplan <ref name="issue8715">{{githubissue|8715}}</ref>=== | |||
Befindet sich der abgerufene Dienstplan außerhalb des minimalen Status, so wird dieser ohne Inhalt angezeigt. | |||
{| class="wikitable alex-blue" | |||
|+ | |||
!Status | |||
!Beschreibung | |||
|- | |||
|Nicht erzeugt | |||
|Weiterführende Informationen finden Sie [[Statustreppe#Nicht erzeugt|hier]]. | |||
|- | |||
|Planung | |||
|Weiterführende Informationen finden Sie [[Statustreppe#Planung|hier]]. | |||
|- | |||
|Benachrichtigt | |||
| | |||
|- | |||
|Benachrichtigt Planer | |||
| | |||
|- | |||
|Ist | |||
|Weiterführende Informationen finden Sie [[Statustreppe#Ist|hier]]. | |||
|- | |||
|Abgeschlossen | |||
|Weiterführende Informationen finden Sie [[Statustreppe#Abgeschlossen|hier]]. | |||
|- | |||
|Versiegelt | |||
|Weiterführende Informationen finden Sie [[Statustreppe#Versiegelt|hier]]. | |||
|} | |||
== Fußnoten == | ==Fußnoten== | ||
[[Kategorie:Funktionsübersicht]] | [[Kategorie:Funktionsübersicht]] | ||
[[Kategorie:Schnittstellen]] | [[Kategorie:Schnittstellen]] | ||
[[Kategorie:Webservice]] | [[Kategorie:Webservice]] | ||
<references /> | |||
Version vom 17. Juli 2023, 08:42 Uhr
Das WebUI-Webservice - Dienstplan PDF ist eine Programmfunktion zur Abfrage des Dienstplans pro Personal oder Planungseinheit und Datum im Dateiformat PDF. [1]
Ausgangssituation
Voraussetzungen
- Es müssen die Voraussetzungen für den Betrieb des WebUI-Webservice erfüllt sein sein.
- Es muss ein Benutzer mit den gewünschten Druckeinstellungen konfiguriert werden.
Systemeinstellungen: Druck-Einstellungen: Benutzer für Webservice Ausdruck von Monatsplan
- Der Benutzer muss mindestens die Rechte Dienstplan lesen besitzen.
| Ausdruck Benutzer |
|
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:
/AlexPrintPlanPeriod [?planCode=] [&employeeId=] [&date=]
| Parameter | Wertebereich | Beschreibung |
|---|---|---|
planCode |
Zeichenkette | Kurzzeichen einer Planungseinheit |
employeeId |
Datum | Eine Personalnummer, die Planungseinheit ergibt sich aus der Stammzuteilung |
date |
Datum | Datum des Monats des gewünschten Stundennachweises, wenn nicht angegeben Heute |
Beispiel:
http://192.168.0.100:8080/AlexPrintPlanPeriod?date=10.06.2023&employeeId=123
Minimaler Status für Webservice-Ausdruck von Dienstplan [2]
Befindet sich der abgerufene Dienstplan außerhalb des minimalen Status, so wird dieser ohne Inhalt angezeigt.
| Status | Beschreibung |
|---|---|
| Nicht erzeugt | Weiterführende Informationen finden Sie hier. |
| Planung | Weiterführende Informationen finden Sie hier. |
| Benachrichtigt | |
| Benachrichtigt Planer | |
| Ist | Weiterführende Informationen finden Sie hier. |
| Abgeschlossen | Weiterführende Informationen finden Sie hier. |
| Versiegelt | Weiterführende Informationen finden Sie hier. |
