Data types reference > Web Services data types > Patron service > PatronHoldInfo

PatronHoldInfo

The PatronHoldInfo type displays specific hold information for a particular patron.

This type may also be extended by the GroupMemberHoldInfo type.

Ancestors

None

Relevant operations

lookupMyAccountInfo
lookupPatronInfo

Contents

This type has the following elements:

Element

Type

Occ.

Description

holdKey

xs:long

1

Displays a key assigned to the particular hold.

titleKey

xs:long

1

Displays a database key to the title record.

itemID

xs:string

0..1

Displays the item ID.

Note: itemID may not be present if a hold was placed on an order.

callNumber

xs:string

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.

displayableCallNumber

xs:string

0..1

Displays the item's formatted call number.

blanketHoldID

xs:string

0..1

Displays the blanket hold ID.

For more information about blanket holds, see “Place Blanket Hold Wizard” in the Java WorkFlows help.

blanketHoldCopiesNeeded

xs:int

0..1

Displays the number of copies needed to fill the blanket hold.

blanketHoldCopiesReceived

xs:int

0..1

Displays the number of copies actually received for the blanket hold.

expiresDate

xs:date

0..1

Displays the date the hold expires.

holdStatus

xs:int

1

Displays an integer of 1 or 2.

1 means the hold is active. 2 means the hold is inactive.

holdInactiveReasonID

xs:string

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.

holdInactiveReasonDescription

xs:string

0..1

Displays a text description of the hold reason.

holdInactiveType

HoldInactiveType

0..1

Displays the HoldInactiveType information.

itemTypeID

xs:string

0..1

Displays the item’s item type ID.

Note: itemTypeID may not be present if a hold was placed on an order.

itemTypeDescription

xs:string

0..1

Displays a text description of the item’s item type.

title

xs:string

1

Displays the title of the item.

author

xs:string

0..1

Displays the item’s author.

itemLibraryID

xs:string

0..1

Displays the item’s owning library Library ID.

itemLibraryDescription

xs:string

0..1

Displays a text description of the item’s owning library

pickupLibraryID

xs:string

0..1

Displays the item’s pickup library Library ID.

pickupLibraryDescription

xs:string

0..1

Displays a text description of the item’s pickup library.

placedDate

xs:date

1

Displays the date a hold was made.

mailServiceID

xs:string

0..1

Displays the mail service ID (if the item is to be delivered by mail).

mailServiceDescription

xs:string

0..1

Displays a text description of the mail service (if the item is to be delivered by mail).

reserve

xs:boolean

1

Indicates if the hold is for an academic reserve (true) or not (false).

recallStatus

xs:string

1

Displays the recall status assigned to the hold.

(For more information, see “Frequently Used Hold Fields” in the Java WorkFlows help.)

available

xs:boolean

1

Indicates if an item is ready at the pickup library (true) or not (false).

intransit

xs:boolean

1

Indicates if an item is in transit to the pickup library (true) or not (false).

availableDate

xs:date

0..1

Displays the date the hold was made available for pickup.

availableDate is only returned if the setting is not “NEVER”.

availableExpiresDate

xs:date

0..1

Displays the date the hold available date expires.

availableExpiresDate is only returned if the setting is not “NEVER”.

queuePosition

xs:int

1

Displays the patron’s position in the hold queue.

queLength

xs:int

1

Displays the total number of patrons in the hold queue.

suspendStartDate

xs:date

0..1

Displays the date a hold suspension starts.

suspendEndDate

xs:date

0..1

Displays the date a hold suspension ends.

holdPlacedWithOverride

xs:boolean

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.

orderFiscalCycle

xs:int

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.

orderID

xs:string

0..1

Displays the order ID.

Note: orderID will only be present if the hold was placed on “on order” materials.

orderLibraryID

xs:string

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.

orderLibraryDescription

xs:string

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.

orderLine

xs:string

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