eacedd3e01c356f17b1987fda922ff565de87861
[citadel.git] / webcit-ng / api.txt
1
2 Method          URL                             Function
3 ------          ------------------------------  -------------------------------------
4 GET             /                               Site root will redirect to a landing page
5 GET             /ctdl/r/                        returns a JSON-encoded list of accessible rooms
6 OPTIONS         /ctdl/r/ROOMNAME/               returns just what you'd expect
7 PROPFIND        /ctdl/r/ROOMNAME/               Show a bunch of crap
8 GET             /ctdl/r/ROOMNAME/               Returns information about the room (name, view, etc.) in JSON format
9 GET             /ctdl/r/ROOMNAME/msgs.all       JSON array of message list in room
10 GET             /ctdl/r/ROOMNAME/msgs.new       JSON array of message list in room (new messages)
11 GET             /ctdl/r/ROOMNAME/MSGNUM         Retrieve the content of an individual message
12                                                 (Should we output RFC822 fields as HTTP headers?  Decide soon...)
13 PUT             /ctdl/r/ROOMNAME/xxx            DAV operation to insert a new message into a room
14                                                 (The returned ETag will be the new message number)
15 GET             /ctdl/r/ROOMNAME/MSGNUM/json    Retrieve an individual message in a room, encapsulated in JSON
16 GET             /ctdl/c/info                    Returns a JSON representation of the output of an INFO server command
17 POST            /ctdl/a/login                   Send it a your credentials and it will log you in
18 GET             /ctdl/a/whoami
19 GET             /ctdl/u/USERNAME/userpic        Returns an image containing the photo/avatar of the specified user
20 GET             /ctdl/s/                        Static content (html, css, js, images...)
21 GET             /.well-known/                   Static content (RFC5785 compliant paths)