[open-ils-commits] r16032 - trunk/Open-ILS/src/perlmods/OpenILS/Application (erickson)

[svn at svn.open-ils.org]

Author: erickson
Date: 2010-03-29 09:10:25 -0400 (Mon, 29 Mar 2010)
New Revision: 16032

Modified:
   trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
Log:
more patron update docs

Modified: trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
===================================================================
--- trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm	2010-03-29 13:02:24 UTC (rev 16031)
+++ trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm	2010-03-29 13:10:25 UTC (rev 16032)
@@ -316,7 +316,16 @@
     method   => "update_patron",
     api_name => "open-ils.actor.patron.update",
     signature => {
-        desc   => 'Update an existing user, or create a new one.',
+        desc   => q/
+            Update an existing user, or create a new one.  Related objects,
+            like cards, addresses, survey responses, and stat cats, 
+            can be updated by attaching them to the user object in their
+            respective fields.  For examples, the billing address object
+            may be inserted into the 'billing_address' field, etc.  For each 
+            attached object, indicate if the object should be created, 
+            updated, or deleted using the built-in 'isnew', 'ischanged', 
+            and 'isdeleted' fields on the object.
+        /,
         params => [
             { desc => 'Authentication token', type => 'string' },
             { desc => 'Patron data object',   type => 'object' }