get_item_status()

Function:
get_item_status ($bnum, $force_refresh = FALSE)

Purpose:
get_item_status() takes a bib number and returns item availability information.

Arguments:
$bnum : (string) required Item bib number
$force_refresh : (boolean) optional Forces a refresh on the availability cache for that item.

Returns:

Array of availability information
(
    [total] => (int) Total number of items in the system
    [avail] => (int) Total number of items currently available
    [holds] => (int) Total number of holds on the item
    [on_order] => (int) Total number of copies on order
    [orders] => Array of order descriptors
        (
            [] => (string) Description of order
        )
    [nextdue] => (int) UNIX timestamp for when the next item is due
    [items] => Array of individual item availability
        (
            [] => Array
                (
                    [location] => (string) Readable location of this item
                    [loc_code] => (string) Location code of this item
                    [callnum] => (string) Call number of this item
                    [statusmsg] => (string) Item status message
                    [due] => (int) UNIX timestamp for when this item is due
                    [avail] => (int) 0 = Item is not available, 1 = Item is available
                    [age] => (string) Age/audience level of this item
                    [branch] => (string) Branch code/identifier for this item
                )
        )
    [locations] => Array of locations that have this item associated with it
        (
            [(string) Location code] => Array of available ages at this location
                (
                    [(string) Age name] => (int) # of items in that age range/section
                )
        )
    [callnums] => Array of call numbers
        (
            [] => (string) Call number
        )
    [ages] => Array of ages associated with this record
        (
            [(string) Age] => Array of availability for that age grouping
                (
                    [avail] => (int) # of items currently available in that age grouping
                    [total] => (int) Total # of items belonging to that age grouping
                )
        )
    [branches] => Array of branches where this item may live
        (
            [(string) Branch code] => Array of availability for that branch
                (
                    [avail] => (int) # of items currently available at that branch
                    [total] => (int) Total # of items belonging to that branch
                )
        )
)

Example:

Array
(
    [total] => 6
    [avail] => 0
    [holds] => 24
    [on_order] => 5
    [orders] => Array
        (
            [0] => 2 copies being processed for New Fiction .
            [1] => 3 copies being processed for New Fiction Express.
        )
 
    [nextdue] => 1264568400
    [items] => Array
        (
            [0] => Array
                (
                    [location] => New Fiction
                    [loc_code] => m1fgr
                    [callnum] => Fic DEE
                    [statusmsg] => DUE 02-17-10
                    [due] => 1266382800
                    [avail] => 0
                    [age] => adult
                    [branch] => nc
                )
 
            [1] => Array
                (
                    [location] => New Fiction
                    [loc_code] => m1fgr
                    [callnum] => Fic DEE
                    [statusmsg] => DUE 02-17-10
                    [due] => 1266382800
                    [avail] => 0
                    [age] => adult
                    [branch] => nc
                )
 
            [2] => Array
                (
                    [location] => New Fiction
                    [loc_code] => m1fgr
                    [callnum] => Fic DEE
                    [statusmsg] => DUE 02-09-10
                    [due] => 1265691600
                    [avail] => 0
                    [age] => adult
                    [branch] => nc
                )
 
            [3] => Array
                (
                    [location] => New Fiction Express
                    [loc_code] => m1fgx
                    [callnum] => Fic DEE
                    [statusmsg] => DUE 01-28-10
                    [due] => 1264654800
                    [avail] => 0
                    [age] => adult
                    [branch] => dl
                )
 
            [4] => Array
                (
                    [location] => New Fiction Express
                    [loc_code] => m1fgx
                    [callnum] => Fic DEE
                    [statusmsg] => DUE 01-27-10
                    [due] => 1264568400
                    [avail] => 0
                    [age] => adult
                    [branch] => dl
                )
 
            [5] => Array
                (
                    [location] => New Fiction Express
                    [loc_code] => m1fgx
                    [callnum] => Fic DEE
                    [statusmsg] => DUE 01-28-10
                    [due] => 1264654800
                    [avail] => 0
                    [age] => adult
                    [branch] => dl
                )
 
        )
 
    [locations] => Array
        (
            [m1fgr] => Array
                (
                    [adult] => 3
                )
 
            [m1fgx] => Array
                (
                    [adult] => 3
                )
 
        )
 
    [callnums] => Array
        (
            [0] => Fic DEE
        )
 
    [ages] => Array
        (
            [adult] => Array
                (
                    [avail] => 0
                    [total] => 6
                )
        )
 
    [branches] => Array
        (
            [nc] => Array
                (
                    [avail] => 0
                    [total] => 3
                )
            [dl] => Array
                (
                    [avail] => 0
                    [total] => 3
                )
        )
)