The PatronHoldInfo type displays specific hold information for a particular patron.
Ancestors
None
Relevant operations
• | lookupMyAccountInfo |
• | lookupPatronInfo |
Contents
This type has the following elements:
Element |
Type |
Occ. |
Description |
1 |
Displays a key assigned to the particular hold. |
||
1 |
Displays a database key to the title record. |
||
0..1 |
Displays the item ID. Note: itemID may not be present if a hold was placed on an order. |
||
0..1 |
Displays the item's call number. This is especially important for multi-volume titles so that the Analytic Z value can display. For more information, see Volume holds. |
||
0..1 |
Displays the item's formatted call number. |
||
0..1 |
Displays the blanket hold ID. For more information about blanket holds, see “Place Blanket Hold Wizard” in the Java WorkFlows help. |
||
0..1 |
Displays the number of copies needed to fill the blanket hold. |
||
0..1 |
Displays the number of copies actually received for the blanket hold. |
||
0..1 |
Displays the date the hold expires. |
||
1 |
Displays an integer of 1 or 2. 1 means the hold is active. 2 means the hold is inactive. |
||
0..1 |
Displays the hold reason ID. Each holdInactiveReasonID will be associated with a holdInactiveType. For more information on holdInactive elements, see “Hold Reason Wizard” in the Java WorkFlows help. |
||
0..1 |
Displays a text description of the hold reason. |
||
0..1 |
Displays the HoldInactiveType information. |
||
0..1 |
Displays the item’s item type ID. Note: itemTypeID may not be present if a hold was placed on an order. |
||
0..1 |
Displays a text description of the item’s item type. |
||
1 |
Displays the title of the item. |
||
0..1 |
Displays the item’s author. |
||
0..1 |
Displays the item’s owning library Library ID. |
||
0..1 |
Displays a text description of the item’s owning library |
||
0..1 |
Displays the item’s pickup library Library ID. |
||
0..1 |
Displays a text description of the item’s pickup library. |
||
1 |
Displays the date a hold was made. |
||
0..1 |
Displays the mail service ID (if the item is to be delivered by mail). |
||
0..1 |
Displays a text description of the mail service (if the item is to be delivered by mail). |
||
1 |
Indicates if the hold is for an academic reserve (true) or not (false). |
||
1 |
Displays the recall status assigned to the hold. (For more information, see “Frequently Used Hold Fields” in the Java WorkFlows help.) |
||
1 |
Indicates if an item is ready at the pickup library (true) or not (false). |
||
1 |
Indicates if an item is in transit to the pickup library (true) or not (false). |
||
0..1 |
Displays the date the hold was made available for pickup. availableDate is only returned if the setting is not “NEVER”. |
||
0..1 |
Displays the date the hold available date expires. availableExpiresDate is only returned if the setting is not “NEVER”. |
||
1 |
Displays the patron’s position in the hold queue. |
||
1 |
Displays the total number of patrons in the hold queue. |
||
0..1 |
Displays the date a hold suspension starts. |
||
0..1 |
Displays the date a hold suspension ends. |
||
0..1 |
Indicates if the hold was placed with an override (true) or not (false). Note: holdPlacedWithOverride will not be returned in a “traditional holds” configuration. |
||
0..1 |
Displays the fiscal cycle associated with the order. For more information about order elements, see “Orders Tab (Search by Order Data)” in the Java WorkFlows help. Note: orderFiscalCycle will only be present if the hold was placed on “on order” materials. |
||
0..1 |
Displays the order ID. Note: orderID will only be present if the hold was placed on “on order” materials. |
||
0..1 |
Displays the Library ID of the library where the item was ordered. Note: orderLibraryID will only be present if the hold was placed on “on order” materials. |
||
0..1 |
Displays a text description of the library where the item was ordered. Note: orderLibraryDescription will only be present if the hold was placed on “on order” materials. |
||
0..1 |
Displays the item’s orderline number. Note: orderLine will only be present if the hold was placed on “on order” materials. |
© 2009-2012 SirsiDynix