RESTles

Abfragen

Veranstaltung existiert

Aufbau: $SERVERNAME:$PORT:/$PFAD/key/$KEY
z.B.: http://mannitalks.ath.cx:8084/lecturate/key/8Kpn

Da es bei der Eingabe des Veranstaltungsschlüssels mit dem # Zeichen Probleme geben kann, ist es möglich, den Schlüssel ohne führendes # abzufragen. Alternativ muss das Zeichen in einer gültigen Umschreibung für HTTP (%23) angegeben werden, also in der Form %238Kpn.

Anwort:

<lecture>
<key>#8Kpn</key>
<exist>true</exist>
</lecture>

Kommentar eintragen

Zum Beispiel mittels eines HTML Formulars und HTTP GET Methode.

Aufbau: $SERVERNAME:$PORT:/$PFAD/comment/add?
z.B.: http://mannitalks.ath.cx:8084/lecturate/comment/add?lk=%23abcd&un=LectuRate+Webseite&uid=webseite&txt=Hallo%2C+verstehe+leider+nicht+alles+was+sie+da+sagen+hier+hinten+in+der+Ecke%2C+k%C3%B6nnten+sie+das+nochmal+n%C3%A4her+erl%C3%A4utern%3F+Man+versteht+leider+%C3%BCb&remLen2=0&a1=9&a2=7&a3=3

Parameter

lk = Veranstaltungsschlüssel
un = Benutzername
uid = BenutzerID
txt = Mitteiltungstext
a1 = Attributwert 1
a2 = Attributwert 2
a3 = Attributwert 3

Problematisch ist bei dieser Art des Eintrags die URL Länge, die durch den HTTP GET Request erzeugt wird. Während die meisten Browser bis ca. 2000 Zeichen keine Probleme bereiten, sind manche Proxies und Webserver mit URLs länger als 255 Zeichen überfordert. Die oben angeführte Beispiel-URL hat aber bereits eine Gesamtlänge von 294 Zeichen. Diese Werte werden bei maximaler Ausnutzung des Zeichenvorrates noch durch länger Benutzernamen, Benutzer-IDs, Serverpfade und Veranstaltungsschlüssellänge beeinflusst. Auch weitere Sonderzeichen können die URL verlängern. Da aber jeder frei editierbare Text durch die Verwendung von Sonderzeichen um den Faktor 3 vergrößert werden könnte, bleibt ein Restrisiko, das die URL für bestimmte Server ungeeignet sein könnten. Da die Zahl der Geräte immer weiter schrumpft und der RFC 2616 (Hypertext Transfer Protocol HTTP/1.1) section 3.2.1 keine maximale Länge für URLs vorschreibt, wird die Funktion nicht weiter eingeschränkt.

Eine elegantere Lösung wäre die Verwendung des aufgabengerechten HTTP POST Kommandos, hier scheiterte jedoch die praktische Umsetzung im LectuRate Server Programm. Durch die niedrige Priorisierung des Problems wurden jedoch weitere Versuche mit anderen Webservice Rahmenwerken bislang nicht durchgeführt.