» Home › Connector Developer's Guide › Connector Functions ›

patron_holds()

» Submitted by jblyberg on Sun, 09/27/2009 - 11:11pm

Function:
patron_holds ($cardnum, $pin = NULL)

Purpose:
patron_holds() needs to return an array of items currently on hold to the cardholder. Locum's client class (locum_client) passes this information up to its calling application.

Arguments:
$cardnum : (string) required The patron's library card number.
$pin : (string) optional The patron's PIN number or password.

Expected Result:

Array
(
    [] => Array of on-hold items (1 for each item on-hold)
        (
            [bnum] => (string) Bib number of on-hold item
            [title] => (string) Title of on-hold item
            [ill] => (int) 1 = item is an ILL, 0 = item is from the local collection
            [status] => (string) Where the hold is in the queue
            [is_frozen] => (int) 1 = Hold is frozen, 0 = hold is not frozen
            [can_freeze] => (int) 1 = Hold can be frozen, 0 = hold cannot be frozen
            [pickuploc] => Array of possible pickup locations and  current information
                (   
                    [selectid] => (string) A unique identifier that refers to the pickup location of this item
                    [options] => Array of values => labels of pickup locations
                        (   
                            [{Value to pass back}] => (string) Pickup location label
                        )
 
                    [selected] => (string) Currently pickup location variable
                )
        )
)