From: Art Cancro Date: Tue, 3 Oct 2023 18:26:11 +0000 (-0400) Subject: api.txt: updated X-Git-Tag: v997~131 X-Git-Url: https://code.citadel.org/?p=citadel.git;a=commitdiff_plain;h=1c80a967ee3b72c82a95f7dbb951fa68adccb1d8 api.txt: updated --- diff --git a/webcit-ng/api.txt b/webcit-ng/api.txt index 97ae9c0d5..533666748 100644 --- a/webcit-ng/api.txt +++ b/webcit-ng/api.txt @@ -1,37 +1,37 @@ -Method URL Function ------- ------------------------------ ------------------------------------- -GET / Site root will redirect to a landing page -GET /ctdl/f/ returns a JSON-encoded list of accessible floors -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/mailbox JSON dictionary of a mailbox summary in this room -GET /ctdl/r/ROOMNAME/stat JSON dictionary of the server STAT command (room name and modification time) -GET /ctdl/r/ROOMNAME/MSGNUM Retrieve the content of an individual message -GET /ctdl/r/ROOMNAME/MSGNUM/json Retrieve an individual message in a room, encapsulated in JSON -GET /ctdl/r/ROOMNAME/MSGNUM/ Retrieve a MIME component of a message, specified by partnum -DELETE /ctdl/r/ROOMNAME/MSGNUM Deletes a message from a room -MOVE /ctdl/r/ROOMNAME/MSGNUM Moves a message to another room (requires Destination) +Method URL Function +------ ------------------------------ ------------------------------------- +GET / Site root will redirect to a landing page +GET /ctdl/f/ returns a JSON-encoded list of accessible floors +GET /ctdl/r/ returns a JSON-encoded list of accessible rooms +OPTIONS /ctdl/r// returns just what you'd expect +PROPFIND /ctdl/r// Show a bunch of crap +GET /ctdl/r// Returns information about the room (name, view, etc.) in JSON format +GET /ctdl/r//info.txt Returns the room info banner for this room +GET /ctdl/r//msgs.all JSON array of message list in room +GET /ctdl/r//msgs.new JSON array of message list in room (new messages) +GET /ctdl/r//mailbox JSON dictionary of a mailbox summary in this room +GET /ctdl/r//stat JSON dictionary of the server STAT command (room name and modification time) +GET /ctdl/r// Retrieve the content of an individual message +GET /ctdl/r///json Retrieve an individual message in a room, encapsulated in JSON +GET /ctdl/r/// Retrieve a MIME component of a message, specified by partnum +DELETE /ctdl/r// Deletes a message from a room +MOVE /ctdl/r// Moves a message to another room (requires Destination) -PUT /ctdl/r/ROOMNAME/xxx DAV operation to insert a new message into a room +PUT /ctdl/r// DAV operation to insert a new message into a 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 +GET /ctdl/r//slrp Set the "Last Read Pointer" for the room Accepted parameters: last The number of the most recently seen message -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 +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 GET /ctdl/a/whoami -GET /ctdl/a/biff Check for new mail -POST /ctdl/a/upload Handler for uploading attachments and other file items -GET /ctdl/u/USERNAME/userpic Returns an image containing the photo/avatar of the specified user -GET /ctdl/s/ Static content (html, css, js, images...) -GET /.well-known/ Static content (RFC5785 compliant paths) +GET /ctdl/a/biff Check for new mail +POST /ctdl/a/upload Handler for uploading attachments and other file items +GET /ctdl/u//userpic Returns an image containing the photo/avatar of the specified user +GET /ctdl/s/ Static content (html, css, js, images...) +GET /.well-known/ Static content (RFC5785 compliant paths) diff --git a/webcit-ng/static/images/dotcrawl.gif b/webcit-ng/static/images/dotcrawl.gif new file mode 100755 index 000000000..09656ae94 Binary files /dev/null and b/webcit-ng/static/images/dotcrawl.gif differ