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

[svn at svn.open-ils.org]

Author: erickson
Date: 2010-04-26 10:37:59 -0400 (Mon, 26 Apr 2010)
New Revision: 16303

Modified:
   trunk/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm
Log:
bulked up the API docs for holds queue stats method

Modified: trunk/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm
===================================================================
--- trunk/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm	2010-04-26 13:18:59 UTC (rev 16302)
+++ trunk/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm	2010-04-26 14:37:59 UTC (rev 16303)
@@ -965,7 +965,27 @@
     method    => "retrieve_hold_queue_stats",
     api_name  => "open-ils.circ.hold.queue_stats.retrieve",
     signature => {
-        desc => q/Returns object with total_holds count, queue_position, potential_copies count, and status code/,
+        desc   => 'Returns summary data about the state of a hold',
+        params => [
+            { desc => 'Authentication token',  type => 'string'},
+            { desc => 'Hold ID', type => 'number'},
+        ],
+        return => {
+            desc => q/Summary object with keys: 
+                total_holds : total holds in queue
+                queue_position : current queue position
+                potential_copies : number of potential copies for this hold
+                estimated_wait : estimated wait time in days
+                status : hold status  
+                     -1 => error or unexpected state,
+                     1 => 'waiting for copy to become available',
+                     2 => 'waiting for copy capture',
+                     3 => 'in transit',
+                     4 => 'arrived',
+                     5 => 'hold-shelf-delay'
+            /,
+            type => 'object'
+        }
     }
 );