From 1c80a967ee3b72c82a95f7dbb951fa68adccb1d8 Mon Sep 17 00:00:00 2001 From: Art Cancro Date: Tue, 3 Oct 2023 14:26:11 -0400 Subject: [PATCH] api.txt: updated --- webcit-ng/api.txt | 54 +++++++++++++-------------- webcit-ng/static/images/dotcrawl.gif | Bin 0 -> 4620 bytes 2 files changed, 27 insertions(+), 27 deletions(-) create mode 100755 webcit-ng/static/images/dotcrawl.gif 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 0000000000000000000000000000000000000000..09656ae940286f184a4041dad779f32739ca25b9 GIT binary patch literal 4620 zcmdUyX;f2p8i()AzLSIiSy*mDY_UTfMCuVlgc}e<42yswsDKdx!xF#<3N&F~g0hJs zs1X^cNEIEbRS^|EDwa}fvCE9(Afw%e@wAq9YRkyHm$;4A&Y5$@59JG=;3UuQ{k_lo z4_v%xo@atD!azz8B)>5K!o>@>KfgWk!$j+z){$!?<9EkRTTPP>CQFJ+hOP{ae?30= z(`4Vtz8inKF>!BVYHAAkUw-6MY;{27GL>Igfcq>rG75hyzfWOs;I}LBe~6EPP#ZAi zR!z#D7zxU4^b2*>vLQ=Q~oU33M2i&AC_FfgHr1LZKe9W~j?ur05VxFx)cvj(l zvHS%*WZ*3{h|yD-_D@-v30-&D^K|+dIa?Q}pfKYT(^ye-W~xG)zG7uDzqDLmSzS|5 z7d+<;1r7C_zhGf73611OFJ5Bix3%-bI{mr=0vEgWo$fz#)=mEW=PaR+C>AKdD>5Ro zy{-Mm%^Ls?sA*HRy+?cPrS^^WjerU80a>6nG)xe@J$4%)j(j|#P1p7w>vet2wXv!3 zd6d+>=2t8ny2=9LhF|-@!|Qe5;ffl!3({b!pTJXDbn#36Y{a1~C|p??WWd`52Sl@X zOBc;57uYzOiW!33$UakG0ws^49GR=hQ6K&XBQq;UpPRULowOiT$}kjVD>iP*v)YoB zY}$$%rF31Lv>}%^&nwbrg^kTJ9+{M@5G@T2UnUJ&c=X`ghga?CRnV9emhT&v2d}(0 z^u~*sTo@o`C`26sOb8$!kJvjBC}5aGwjxuN2{;fy`ul(kK;y7DC1oWrc>qU~q-pPH z2R<-i9_}8`3>ozR_Uc0>wV4t{BY)`F&0NP=#Nf|g9ZJ3x&y$37U+bylaN}LCg;j}a zf>rdx(CJ8|PCMc$T-qy;G( z)~C~XXgRGiw<+JArF&ChELLpak)v;^@msJ^j3fSW^wl9OXK{EeKQekxOl)B967F%u zi3t1GscLr$deQ6JMi5g%;H0%}_%&{Z8phPS-re`|*Rkbvfe{emM>9F$0`#=3Wxy0}J z_CCzQveGP69}e6P6FK@ENCcV*=>TDGFK@sb8663gCaU{jvUOK0bQ?k;`h0gB%HQ49 z4g5XkdO$9g$%c%)eY_#TmlO)^_}RKgS>(0y=T`>=Rvgjzt2^}b>*6~0^C+XWC7uY< zImfdd<*xriF{nRt{?a>S%a0bhfs@m1Mr+VKuX8~j(b9O?H6zx^DwL=!&hw#&9tYw^dh9otKk(|m%%iu1{ zmg$F$R-}Bq5Hl8+-m$wGY)oJa;wvevnAqto@E2!6^kVGM*0?tTbpZZ3Svex1h}a!p zj}xVs-V5D_x&bneF~}+K zxlmprpY(N=rDkuK-`aqDTm3pIUYn^*obs>)r9I-uL7j5lzJtk;CMU zsDP`o6R^cB=CqdG z*=A1LyC*vjz>1c0(LY9E48szek-s^*;IUc$5$|~rZ zFRyy^x1VDe?iYC@z9pwB$UXz#tXSb=CAVT|tjIA6)LNvXT61K$v_gv8>#0gqZ_9Pk zBQ)H!74ndAtasodYgBb zq+!`au&n?*2o|aWO|W3L_~YqK2hOlW2T@p3h1_074v*DC>wl^t+Ok)y+puE3+H2>f zOL?t9-mUVrI!P92iBEIhBKAe3b-cM#<^b zbezG&B)FqUPqCKq^ax63wId|L7A-g*1EW-#R8*`EZ^WA9J7Iw#X8L|T1{LW)JJ2KN zqrK5c zyD{GB*0|Lvm?K+*CyB3ZNc+UWDLfza9=<7W3#rq9*|2Y5lAEKk6L?qzzdj$F{{0j} z7BWdMOyuc7|BWfV?}^d}wO+4Y7*709kmxEAOw6l`>l(1wd-TK6doF8~f4;l?QzK$u zA6`yIGQF(n1qe6HAtRP>y2|43>WBU&tR7um<18%((-(v3yKM4y@7+i2G3Q3dCTHje zdNdUdtPW=ZNF5x1*6a*kPq89taxg4qLt2iVO!pCJzA%rGU&t^PbEC>{slQvAvKh=? zMPbEGOd%-kziH&*Yv8x#^;1u8Ew7rrR^Q4K7z_FDU6lSb?ezh!r^mLQTEE#Ghel)X z&r#(U?^NSD!7K!^CdnNPh&}ei>yIQ}@JQlt-a4@itO)xuaDAD@_0$gN$gWoKxOu}d z)rtC~10eag4Tq1Eu~%UXeQt(Ss@JCDnOL?HXk8`TBE(CL#pC6bq4z?0*^NS*`r(V!^8Ns=gOrIU2ppY5~{7B>CSLJGCG#C|7NICS%oo> zeLY4u1gUymaM^WHnW^NICxt{0_p6_6vTgRoJ!b9=NZFuB&s4DD5nCBrA+VDbBqgV6 z=@N-fmJKJrwRd4dQQD5?^7txAjV^S)jL9YYMg@?Afo4{pmHCE4-s;AtnAE z%s8R*l6akK9Eo~+EKxFJ*!r%-^=RB>#hjJz5C0B9D08gs)+B5S