webcit-ng/api.txt

   1 Method          URL                                Function
   2 ------          ------------------------------     -------------------------------------
   3 GET             /                                  Site root will redirect to a landing page
   4 GET             /ctdl/f/                           returns a JSON-encoded list of accessible floors
   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>/info.txt        Returns the room info banner for this room
  10 GET             /ctdl/r/<roomname>/msgs.all        JSON array of message list in room
  11 GET             /ctdl/r/<roomname>/msgs.new        JSON array of message list in room (new messages)
  12 GET             /ctdl/r/<roomname>/mailbox         JSON dictionary of a mailbox summary in this room
  13 GET             /ctdl/r/<roomname>/stat            JSON dictionary of the server STAT command (room name and modification time)
  14 GET             /ctdl/r/<roomname>/<msgnum>        Retrieve the content of an individual message
  15 GET             /ctdl/r/<roomname>/<msgnum>/json   Retrieve an individual message in a room, encapsulated in JSON
  16 GET             /ctdl/r/<roomname>/<msgnum>/<part> Retrieve a MIME component of a message, specified by partnum
  17 DELETE          /ctdl/r/<roomname>/<msgnum>        Deletes a message from a room
  18 MOVE            /ctdl/r/<roomname>/<msgnum>        Moves a message to another room (requires Destination)
  19
  20 PUT             /ctdl/r/<roomname>/<xxx>           DAV operation to insert a new message into a room
  21                 Accepted parameters:
  22                 wefw List of message references, separated by "!" delimiter
  23                 subj Message subject
  24                 The returned ETag will be the new message number.
  25
  26 GET             /ctdl/r/<roomname>/slrp            Set the "Last Read Pointer" for the room
  27                 Accepted parameters:
  28                 last The number of the most recently seen message
  29
  30 GET             /ctdl/c/info                       Returns a JSON representation of the output of an INFO server command
  31 POST            /ctdl/a/login                      Send it a your credentials and it will log you in
  32 GET             /ctdl/a/whoami
  33 GET             /ctdl/a/biff                       Check for new mail
  34 GET             /ctdl/u/<username>/userpic         Returns an image containing the photo/avatar of the specified user
  35 GET             /ctdl/s/                           Static content (html, css, js, images...)
  36 GET             /.well-known/                      Static content (RFC5785 compliant paths)
  37 POST            /ctdl/p                            Handler for uploading attachments and other file items
  38                                                    The JSON returned wil contain one or more uploads in an array like this:
  39                                                    [
  40                                                      {
  41                                                        "uploadfilename" : "Track 01.wav",
  42                                                        "contenttype" : "audio/wav",
  43                                                        "ref" : "cdarzowkk",
  44                                                        "contentlength" : 56222252
  45                                                      }
  46                                                    ]
  47 GET             /ctdl/p/<ref>                      Fetch a specific item that was uploaded ("ref" was returned by the upload)
  48 DELETE          /ctdl/p/<ref>                      Delete a specific item that was uploaded ("ref" was returned by the upload)
  49 GET             /ctdl/p/<msgnum>                   Load the attachments from message <msgnum> in, as if they were uploaded
  50                                                    by the client.  Returns the same JSON as "POST /ctdl/p".