X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;ds=inline;f=proto.txt;h=18a541697bcd0cb3a612758a9554e7ae422536e1;hb=36dc59549949567a7ed0113a6ad2e4cd90ae4975;hp=b45d7a6032877029d737b0f273e42c73d4b6549b;hpb=5df82cb2854e4f7c693c8a31e0c2d56682a93855;p=tpg%2Fopendispense2.git diff --git a/proto.txt b/proto.txt index b45d7a6..18a5416 100644 --- a/proto.txt +++ b/proto.txt @@ -7,7 +7,7 @@ All server responses are on one line and are prefixed by a three digit response == Response Codes == 100 Information 200 Command succeeded, no extra information -201 Command succeeded, array follows ( ...) +201 Command succeeded, multiple lines follow () 202 Command succeeded, per-command format 400 Unknown Command 401 Not Authenticated (or Authentication failure) @@ -35,6 +35,9 @@ If the client is connecting from a trusted machine on a root port then automatic authentication is allowed c AUTOAUTH \n s 200 Auth OK\n or 404 Bad Username\n or 401 Untrusted\n +--- Set effective user (User in `dispense -u`) --- +c SETEUSER \n +s 200 User set\n or 403 Not in coke\n or 404 User not found\n === Commands === --- Dispense an item --- @@ -52,13 +55,30 @@ s 200 Set OK\n or 403 Not Coke\n or 404 Bad User\n --- Get Item list --- c ENUM_ITEMS\n -s 201 Items ...\n +s 201 Items \n +s 202 Item \n + ... +s 200 List End\n --- Get Item Information --- c ITEM_INFO \n s 202 Item \n + --- Get Users' Balances --- -c ENUM_USERS[ ]\n -s 201 Users :: :: ...\n + and can be '-' to indicate "none" +c ENUM_USERS[ []]\n +s 201 Users \n +s 202 User \n + ... +s 200 List End\n --- Get a User's Balance --- c USER_INFO\n s 202 User \n + +--- Add a new user --- +c USER_ADD \n +s 200 User Added\n or 403 Not Wheel\n or 404 User Exists\n +--- Set user flags --- + is a comma-separated list of flag values (optionally preceded by + - to remove the flag) Valid values are: user,coke,wheel,meta,disabled,door +c USER_FLAGS \n +s 200 User Updated\n or 403 Not Wheel\n or 404 Bad User\n or 407 Unknown Flags\n