From dadf34a555bf998897c705b2ffcfa7bb41fb8d6b Mon Sep 17 00:00:00 2001 From: konrad Date: Sun, 23 Jan 2011 11:45:35 +0000 Subject: [PATCH] add more docu and a _web user git-svn-id: https://silmor.de/svn/softmagic/smoke/trunk@710 6e3c4bff-ac9f-4ac1-96c5-d2ea494d3e33 --- wob/db/user.wolf | 9 +++++++++ wob/transact/basics.wolf | 3 +++ wob/transact/customer.wolf | 11 +++++++++++ wob/transact/event.wolf | 15 ++++++++++++++- wob/transact/order.wolf | 29 ++++++++++++++++++++++++++--- wob/transact/template.wolf | 5 +++++ wob/transact/user.wolf | 41 +++++++++++++++++++++++++++++++++++------ 7 files changed, 103 insertions(+), 10 deletions(-) diff --git a/wob/db/user.wolf b/wob/db/user.wolf index 6d69d9c..cc5da81 100644 --- a/wob/db/user.wolf +++ b/wob/db/user.wolf @@ -22,6 +22,13 @@ + + + + + + + @@ -51,6 +58,8 @@
+ +
diff --git a/wob/transact/basics.wolf b/wob/transact/basics.wolf index e7b1fb0..c732dce 100644 --- a/wob/transact/basics.wolf +++ b/wob/transact/basics.wolf @@ -30,18 +30,21 @@ + returns all flags that are defined in the database + changes/creates a flag; warning: if the flag is used this may change behavior + deletes a flag; warning: if the flag is used this may change behavior diff --git a/wob/transact/customer.wolf b/wob/transact/customer.wolf index 00af319..e438fca 100644 --- a/wob/transact/customer.wolf +++ b/wob/transact/customer.wolf @@ -8,6 +8,7 @@ --> + returns the list of all contact types (phone, mail, ...) with detailed data @@ -15,6 +16,7 @@ + creates a new contact type (phone, mail, ...) @@ -26,6 +28,7 @@ + returns detailed info about a customer (excluding password) @@ -36,6 +39,7 @@ + returns basic information (name, title) about all existing customers @@ -44,6 +48,7 @@ + creates a new customer @@ -54,6 +59,7 @@ + changes customer data @@ -64,6 +70,7 @@ + deletes a customer - usually by merging info into another customer @@ -75,6 +82,7 @@ + returns data of one specific address without the remaining customer info @@ -85,6 +93,7 @@ + returns a list of all existing countries in the database @@ -93,6 +102,7 @@ + creates a new country in the database @@ -105,6 +115,7 @@ + sends a reset password mail to the customer - if the customer has a login diff --git a/wob/transact/event.wolf b/wob/transact/event.wolf index 99d2c72..1526471 100644 --- a/wob/transact/event.wolf +++ b/wob/transact/event.wolf @@ -8,12 +8,14 @@ --> + returns a list of all existing artists + creates a new artist @@ -26,6 +28,7 @@ + returns a list of all existing price categories (not event specific) @@ -33,6 +36,7 @@ + creates a new price category (generic, not yet event specific) properties as requested by user @@ -42,8 +46,9 @@ + changes a price category globally - properties as requested by user + properties of the category @@ -52,6 +57,7 @@ + returns detailed event data @@ -62,6 +68,7 @@ + returns data about all existing events @@ -70,6 +77,7 @@ + returns a list of specific events (eg. used by the order window to request exactly those needed by the tickets it shows) @@ -80,6 +88,7 @@ + create a new event @@ -89,6 +98,7 @@ + change event data (like date/time, artist, room, ...) users with this privilege are allowed to set the iscancelled property and hence cancel or uncancel events @@ -100,6 +110,7 @@ + cancel an event @@ -109,6 +120,7 @@ + returns a list of all existing rooms @@ -117,6 +129,7 @@ + creates a new room diff --git a/wob/transact/order.wolf b/wob/transact/order.wolf index 8387516..892da40 100644 --- a/wob/transact/order.wolf +++ b/wob/transact/order.wolf @@ -8,6 +8,7 @@ --> + returns a specific ticket with detailed info @@ -18,6 +19,7 @@ + returns a specific voucher with detailed info @@ -28,6 +30,7 @@ + returns all audit data for a voucher (when it was bought, when it was used and for what) @@ -38,6 +41,7 @@ + returns all audit data for an order (when it was created, who handled it, when it was paid and how, ... @@ -50,6 +54,7 @@ + get details for an order by its ID @@ -60,6 +65,7 @@ + get a complete list of orders starting at the time "oldest" unix timestamp for the oldest order to be returned (compared with ordertime) @@ -71,6 +77,7 @@ + returns all orders that match a specific list of events list of event ids to select unix timestamp for the oldest order to be returned (compared with ordertime) @@ -83,6 +90,7 @@ + returns all orders that were purchased by a specific customer customer to select unix timestamp for the oldest order to be returned (compared with ordertime) @@ -94,6 +102,7 @@ + retrieves the order in which a specific ticket or voucher was bought @@ -111,6 +120,9 @@ users with this privilege can sell tickets for past events - be careful to give this privilege only to very few special users, it is an invitation to mistakes! users with this privilege may use this transaction to create orders users with this privilege may use this transaction to create sales + users with this privilege may put tickets into orders + users with this privilege may put vouchers into orders + users with this privilege may put shop items (merchandise) into orders The cart contents true if this is a sale, false if this is an order @@ -157,6 +169,7 @@ + pay for an order with money/credit card/...; see UseVoucher for using a voucher to pay The order to be paid amount offered, it must be positive @@ -169,6 +182,7 @@ + returns money if too much has been paid (e.g. after an event has been cancelled) @@ -270,7 +284,8 @@ - Users with this privilege can return tickets for events in the past (if they have not been used yet). All others can only return tickets in the future. + Privileged users: return a ticket or voucher and deduct its price from the order it was in. This may fail if the ticket or voucher has already been used. + Users with this privilege can return tickets for events in the past (if they have not been used yet). All others can only return tickets for events in the future. barcode of the ticket or voucher @@ -281,6 +296,7 @@ + Privileged users: change the price of a ticket. Usually you would change its category. users with this privilege can change the price of used tickets - usually a ticket has to be changed before it is used users with this privilege can change the price for tickets that are for past events @@ -293,6 +309,7 @@ + Mildly privileged users: change the category of a ticket (eg. from "normal price" to "reduced price"). The new category must exist for the event concerned. users with this privilege can change the price of used tickets - usually a ticket has to be changed before it is used users with this privilege can change the price for tickets that are for past events @@ -306,6 +323,7 @@ + Returns a list of all shipping methods that the user has access to. This transaction is sensitive to flags, like "anyshipping". @@ -313,6 +331,7 @@ + Changes a shipping method, eg. its default price. Changing the price has no effect on existing orders, while changing the name is reflected in orders - this is due to the order referencing the shipping method, but copying its price so that it can be changed by privileged users. @@ -322,6 +341,7 @@ + Creates a new shipping method. @@ -331,6 +351,7 @@ + Attempts to delete a shipping method. This will fail if the method was used in existing orders - use flags to hide such methods from newer orders. @@ -339,6 +360,7 @@ + Returns a list of voucher values/prices that the system will accept for normal users (which do not have special privileges). @@ -346,6 +368,7 @@ + Attempts to mark a ticket as used. Fails if the ticket has already been used or is not paid for. The ticket to be used The event to use it on @@ -358,8 +381,8 @@ This is a convenience transaction: it returns all events that are likely to be chosen at an entrance barcode scanner; this includes all events starting at max. within the next 24 hours that and that have not ended yet - - + the clients definition of "soon": time in seconds to look into the future for events that will start "soon"; recommended is 24 hours + the clients definition of "yet": time in seconds to look into the past for events that have not ended "yet"; recommended is 1 or 2 hours diff --git a/wob/transact/template.wolf b/wob/transact/template.wolf index 519bf9d..5bdb780 100644 --- a/wob/transact/template.wolf +++ b/wob/transact/template.wolf @@ -8,6 +8,7 @@ --> + Returns the list of templates that this user can access. This transaction is sensitive to flags. @@ -15,6 +16,7 @@ + Returns a specific template @@ -25,6 +27,7 @@ + Overwrites or creates a specific template. @@ -36,6 +39,7 @@ + Changes the description of a template. @@ -43,6 +47,7 @@ + Deletes a template from the server. diff --git a/wob/transact/user.wolf b/wob/transact/user.wolf index 4895e16..5af96db 100644 --- a/wob/transact/user.wolf +++ b/wob/transact/user.wolf @@ -8,6 +8,7 @@ --> + returns basic info about the server - this is part of the protocol handshake @@ -18,11 +19,12 @@ + Attempt to log into the server. Both the user and the host the user is using are verified. The login will fail if the authentication of either of them fails or the user does not have the righ to login from this host. - - - - + name of the user + password of the user + name of the host + the authentication key of the host @@ -32,12 +34,14 @@ + Deletes the current session. + Returns the roles of the user of the current session. @@ -45,6 +49,7 @@ + Returns the rights and flags of the user of the current session. @@ -54,15 +59,17 @@ + Changes the password of the user of the current session. This may fail if the old password does not match or the new password is too weak. - - + this must match the old password of the user to authenticate the change + this is the new password + Returns a list of all existing users. @@ -70,6 +77,7 @@ + Returns one specific user by name @@ -80,6 +88,7 @@ + Attempts to create a new user. This may fail if the user already exists. @@ -92,6 +101,7 @@ + Admins: change/reset the password of a specific user. To be used when a user forgot his/her password. @@ -101,6 +111,7 @@ + Attempt to delete a user. Usually you will need to merge it with another user to move all orders created by that user over to the merge target. If you do not merge and there are orders by that user, the delete operation will fail. @@ -109,6 +120,7 @@ + Changes the description of a user. @@ -117,6 +129,7 @@ + Returns all roles assigned to a specific user. @@ -126,6 +139,7 @@ + Changes the roles assigned to a specific user. @@ -135,6 +149,7 @@ + Returns all hosts a user may log in from. @@ -144,6 +159,7 @@ + Changes the hosts a user may log in from @@ -151,6 +167,7 @@ + Changes the flags of a user. Flags determine what data (events, templates, etc.) a user can use. @@ -159,6 +176,7 @@ + Returns a list of all existing roles. @@ -167,6 +185,7 @@ + Returns a specific role by name. @@ -177,12 +196,14 @@ + Creates a new role. + Changes the description of a role @@ -190,6 +211,7 @@ + Changes the rights assigned to a role @@ -197,12 +219,14 @@ + Attempts to delete a role. + Changes the flags assigned to a role. This changes the data that users with this role can see. @@ -211,6 +235,7 @@ + Returns a list of all rights (i.e. transactions and privileges) that currently exist at the server @@ -218,6 +243,7 @@ + returns a list of all (log in/client) host names that are known to the server @@ -226,6 +252,7 @@ + returns detailed info about all known (log in/client) hosts @@ -234,6 +261,7 @@ + Creates/Changes a host from which users can log in. If the host is already used and you change the key here, you also have to change the key at the client host or no one will be able to log in from it. @@ -243,6 +271,7 @@ + Deletes a host from which users can log in. If the host has been used, then users will lose the ability to log in from it. -- 1.7.2.5