Client side of SLRP is done

[citadel.git] / webcit-ng / api.txt

diff --git a/webcit-ng/api.txt b/webcit-ng/api.txt
index ca344ff521c5e3594622ff42d5d86835ef59122d..a8761daf6eb35fc823cd346a6db62bf10c072370 100644 (file)
--- a/webcit-ng/api.txt
+++ b/webcit-ng/api.txt
@@ -7,13 +7,22 @@ GET           /ctdl/r/                        returns a JSON-encoded list of accessible rooms
 OPTIONS                /ctdl/r/ROOMNAME/               returns just what you'd expect
 PROPFIND       /ctdl/r/ROOMNAME/               Show a bunch of crap
 GET            /ctdl/r/ROOMNAME/               Returns information about the room (name, view, etc.) in JSON format
+GET            /ctdl/r/ROOMNAME/info.txt       Returns the room info banner for this room
 GET            /ctdl/r/ROOMNAME/msgs.all       JSON array of message list in room
 GET            /ctdl/r/ROOMNAME/msgs.new       JSON array of message list in room (new messages)
 GET            /ctdl/r/ROOMNAME/MSGNUM         Retrieve the content of an individual message
                                                (Should we output RFC822 fields as HTTP headers?  Decide soon...)
+
 PUT            /ctdl/r/ROOMNAME/xxx            DAV operation to insert a new message into a room
-                                               (The returned ETag will be the new message number)
-GET            /ctdl/r/ROOMNAME/info.txt       Returns the room info banner for this room
+                                               Accepted parameters:
+                                               wefw    List of message references
+                                               subj    Message subject
+                                               The returned ETag will be the new message number.
+
+GET            /ctdl/r/ROOMNAME/slrp           Set the "Last Read Pointer" for the room
+                                               Accepted parameters:
+                                               last    The number of the most recently seen message
+
 GET            /ctdl/r/ROOMNAME/MSGNUM/json    Retrieve an individual message in a room, encapsulated in JSON
 GET            /ctdl/c/info                    Returns a JSON representation of the output of an INFO server command
 POST           /ctdl/a/login                   Send it a your credentials and it will log you in