From: erickson <erickson@dcc99617-32d9-48b4-a31d-7c20da2025e4>
Date: Wed, 31 Mar 2010 19:44:18 +0000 (+0000)
Subject: fleshed out the docs for the open-ils.circ.hold.has_copy_at method
X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=21555f02956b936050261744e8a8cd19a66b658b;p=evergreen%2Fbjwebb.git

fleshed out the docs for the open-ils.circ.hold.has_copy_at method

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

diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm b/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm
index bad8946a3..4c51ba3b9 100644
--- a/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm
+++ b/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm
@@ -2276,10 +2276,31 @@ sub usr_hold_summary {
 __PACKAGE__->register_method(
     method    => 'hold_has_copy_at',
     api_name  => 'open-ils.circ.hold.has_copy_at',
-    signature => q/
-        Returns the ID of the found copy and name of the shelving location if there is
-        an available copy at the specified org unit.  Returns empty hash otherwise.
-    /
+    signature => {
+        desc => q/
+            Returns the ID of the found copy and name of the shelving location if there is
+            an available copy at the specified org unit.  Returns empty hash otherwise.
+            The anticipated use for this method is to determine whether an item is
+            available at the library where the user is placing the hold (or, alternatively, 
+            at the pickup library) to encourage bypassing the hold placement and just 
+            checking out the item.
+        /,
+        params => {
+            { desc => 'Authentication Token', type => 'string' },
+            { desc => q/
+                    Method Arguments.  Options include:
+                    hold_type  : the hold type code (T, V, C, M, ...)
+                    hold_target : the identifier of the hold target object
+                    org_unit : org unit ID
+                /, 
+                type => 'object' 
+            },
+        },
+        return => { 
+            desc => q/{ "copy" : copy_id, "location" : location_name }/,
+            type => 'object' 
+        }
+    }
 );
 
 sub hold_has_copy_at {