@@ -100,45 +100,31 @@ Diese Updates werden aber nur die Hook Datei beeinflussen. Um die `Main.jar` zu
100
100
selber in die Github releases schauen.
101
101
Falls eine neue Version für ` Main.jar ` verfügbar ist, wird es in der Release Beschreibung stehen.
102
102
103
- # Server Funktionen
103
+ # Datentransfer
104
104
105
- Es ist möglich Befehle an den Server zu senden. Das sind einfach Strings die über einen Socket gesendet werden.
106
- Clients sind auf einen Befehl pro Verbindung beschränkt. Üblicherweise wäre das ein Befehl mit ein paar Argumenten.
107
- > ` do-something "some-argument" `
105
+ Es ist möglich Befehle an den Server zu senden. Das sind einfach Strings die über einen Socket gesendet werden. Maximale Zeichenlänge beträgt 6000.
106
+ Clients sind auf einen Befehl pro Verbindung beschränkt. Üblicherweise wäre das ein Befehl mit ein paar Parametern.<br >
107
+ ` befehl "ein-parameter" `
108
+
109
+ Bis auf Befehle sollte jeglicher Datentransfer zwischen Server und Client im JSON Format erfolgen.
110
+ Standartmäßig sendet der Server Antorten im folgenden Format:
108
111
109
- Bis auf Befehle sollte jeglicher Datentransfer zwischen Server und Client im JSON Format erfolgen:
110
112
``` json
111
113
{
112
- "message" : {
113
- "some" : " data"
114
- }
115
- "error" : " ErrorMessage"
114
+ "data" : " .." ,
115
+ "code" : 0
116
116
}
117
- ```
118
- Bitte beachte, dass immer nur "message" oder "error" im der JSON existieren. Niemals beide gleichzeitig.
119
- Hier ist eine Liste mit Befehlen die mit der aktuellen ` server-hook.jar ` möglich sind:
120
-
121
- Es folgt eine Liste möglicher Befehle, sowie welche Funktionen sie bereitstellen:
122
-
123
- ### convertxssf
124
- * Dieser Befehl erwartet keine Argumente. Wenn eine bestätigung "ready" vom Server gesendet wurde
125
- erwartet der Server eine Excel Datei. Wenn diese Verarbeitet wurde gibt der Server ein Array mit Zellenfarben zurück.
126
-
127
- ### upload-file
128
- ** Argumente**
129
- * JSESSIONID - Die Session ID eines eingeloggten Clients
130
- * Token - Der Bearer Token eines eingeloggten Clients
131
- * KlasseID - Die ID der Klasse
132
- * blockStart - Der Start des Blocks für den die Phasierung ausgelegt ist. Im Format YYYYMMDD
133
- * blockEnd - Das Ende des Blocks für den die Phasierung ausgelegt ist. Im Format YYYYMMDD
134
-
135
- ** Beispiel**
136
- upload-file "d9dz8939e249" "qr3o8azd8edsjd0e9..." "1234" "20220101" "20220101"
137
-
138
- Wenn alle Credentials Korrekt sind erwartet der Server eine Datei als Stream mit folgender Antwort:
139
- Code: 1
140
- Message: "ready-for-file"
141
-
117
+ ```
118
+ Fehlernachricht:
119
+ ``` json
120
+ {
121
+ "error" : " Fehler Nachricht" ,
122
+ "code" : 100
123
+ }
124
+ ```
125
+ Antwort Codes 0-99 sind lediglich Statusmeldungen.
126
+ Codes vom 100-... sind Fehlercodes.
127
+ Eine Liste aller möglichen Codes findest du unter server-hook/Codes.java
142
128
143
129
# Excel Server dependencies:
144
130
0 commit comments