From: erickson <erickson@dcc99617-32d9-48b4-a31d-7c20da2025e4>
Date: Mon, 29 Mar 2010 13:10:25 +0000 (+0000)
Subject: more patron update docs
X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=c9e11ac977cfa8ed02ecad01a5b1976db17dd497;p=evergreen%2Fmasslnc.git

more patron update docs

git-svn-id: svn://svn.open-ils.org/ILS/trunk@16032 dcc99617-32d9-48b4-a31d-7c20da2025e4
---

diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm b/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
index 0823936067..1f69f10f09 100644
--- a/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
+++ b/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
@@ -316,7 +316,16 @@ __PACKAGE__->register_method(
     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' }