X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=notes%2Fproto.txt;h=8a1a1da712a1b08bdc3c90b61d77332cf0ef0daa;hb=7ba426116326af469bc8c73aae4fc1c56ebb3612;hp=d48031e8d48cea4904f635e02d5547ae50cd537e;hpb=3e1c2bf267dea8c592f41636c3d0fb1c7253ee26;p=tpg%2Fopendispense2.git diff --git a/notes/proto.txt b/notes/proto.txt index d48031e..8a1a1da 100644 --- a/notes/proto.txt +++ b/notes/proto.txt @@ -57,7 +57,7 @@ s 200 Auth OK as \n or 401 Untrusted\n or 404 Bad Card ID\n c SETEUSER \n s 200 User set\n or 403 Not in coke\n or 404 User not found\n -=== Commands === +=== Standard User Commands === --- Dispense an item --- c DISPENSE \n s 200 Dispense OK\n or 402 Poor You\n or 406 Bad Item\n or 500 Dispense Error\n @@ -67,10 +67,20 @@ s 200 Give OK\n or 402 Poor You\n or 404 Bad User\n --- Donate to the club --- c DONATE \n s 200 Give OK\n or 402 Poor You\n + +=== Coke Member Commands (Account Manipulation) === --- Alter balance --- c ADD \n s 200 Add OK\n or 402 No balance\n or 403 Not Coke\n or 404 Bad User\n +--- Set balance --- +c SET \n +s 200 Add OK\n or 402 No balance\n or 403 Not Coke\n or 404 Bad User\n +--- Refund a drink --- +c REFUND [ ]\n +s 200 Add OK\n or 403 Not Coke\n or 404 Bad User\n 406 Bad Item\n + +=== Items === --- Get Item list --- c ENUM_ITEMS\n s 201 Items \n @@ -81,6 +91,11 @@ s 200 List End\n c ITEM_INFO \n s 202 Item \n "avail", "sold", or "error" +--- Update an item --- +c UPDATE_ITEM \n +s 200 Item updated + +=== Users === --- Get Users' Balances --- c ENUM_USERS[ min_balance:][ max_balance:][ flags:][ last_seen_before:][ last_seen_after:][ sort:[-desc]]\n s 201 Users \n @@ -95,6 +110,7 @@ s 200 List End\n c USER_INFO\n s 202 User \n +=== User Manipulation === --- Add a new user --- c USER_ADD \n s 200 User Added\n or 403 Not Wheel\n or 404 User Exists\n