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

PatronCheckoutInfo

The PatronCheckoutInfo type displays specific checkout information for a particular patron.

This type may also be extended by the GroupMemberCheckoutInfo type.

Ancestors

None

Relevant operations

lookupMyAccountInfo
lookupPatronInfo

Contents

This type has the following elements:

Element

Type

Occ.

Description

titleKey

xs:long

0..1

Displays a database key to the title record.

itemID

xs:string

1

Displays the item ID.

callNumber

xs:string

1

Displays the item call number.

copyNumber

xs:int

1

Displays which copy of the item if multiple copies exist.

pieces

xs:int

1

Displays the number of pieces or parts that are included with the item (for multi-part items such as a book with a CD).

numberOfPiecesReturned

xs:int

0..1

Displays the number of pieces or parts that were returned at check in (for multi-part items such as a book with a CD).

title

xs:string

0..1

Displays the title of the item.

author

xs:string

0..1

Displays the item’s author.

checkoutLibraryID

xs:string

0..1

Displays the library where the item was checked out.

checkoutLibraryDescription

xs:string

0..1

Displays a text description of the library where the item was checked out.

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.

itemTypeID

xs:string

0..1

Displays the item’s item type ID.

itemTypeDescription

xs:string

0..1

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

reserveCollectionID

xs:string

0..1

Displays the reserve collection ID.

This element is only returned if the item is on academic reserve.

reserveCollectionDescription

xs:string

0..1

Displays a text description of the reserve collection.

This element is only returned if the item is on academic reserve.

checkoutDate

xs:dateTime

1

Displays the date the item was checked out.

dueDate

xs:dateTime

1

Displays the item’s due date.

recallDate

xs:date

0..1

Displays the date a recall notice was sent.

This element is returned only if the checkout has been recalled.

recallDueDate

xs:dateTime

0..1

Displays the item due date after it is recalled.

recallNoticesSent

xs:int

0..1

Displays the number of recall notices that have been sent.

lastRenewedDate

xs:dateTime

0..1

Displays the date the item was last renewed.

renewals

xs:int

1

Displays the number of times the item has been renewed.

unseenRenewals

xs:int

1

Number of times the item was renewed without being seen by library staff (i.e. patron self-renewed).

renewalsRemaining and renewalsRemainingUnlimited are a choice. Values will be returned for one element or the other.

renewalsRemaining

xs:int

0..1

Displays the number of times an item can be renewed.

Note: The renewalsRemaining elements are a choice. If there is a number of renewals remaining, renewalsRemainingUnlimited will not display.

renewalsRemainingUnlimited

xs:boolean

Indicates if the number of remaining renewals is unlimited.

Note: The renewalsRemaining elements are a choice. If renewalsRemainingUnlimited is “true”, then renewalsRemaining will not display.

unseenRenewalsRemaining and unseenRenewalsRemainingUnlimited are a choice. Values will be returned for one element or the other.

unseenRenewalsRemaining

xs:int

0..1

Displays the number of times an item can be renewed unseen.

Note: The unseenRenewalsRemaining elements are a choice. If there is a number of unseen renewals remaining, unseenRenewalsRemainingUnlimited will not display.

unseenRenewalsRemainingUnlimited

xs:boolean

Indicates if the number of remaining renewals is unlimited.

Note: The renewalsRemaining elements are a choice. If renewalsRemainingUnlimited is “true”, then renewalsRemaining will not display.

overdue

xs:boolean

1

Indicates whether the item is overdue (true) or not (false).

overdueNoticesSent

xs:int

1

Displays the number of overdue notices the system has sent for an item.

dateOfLastOverdueNotice

xs:date

0..1

Displays the date that the last overdue notice was sent.

This element is returned only if the setting is not “NEVER”.

fine

Money

0..1

Displays the monetary amount of fine associated with the item.

This amount includes both any outstanding bills on the checkout and the estimated fine that would accrue if the item was returned at the time of the operation request.

 


© 2009-2012 SirsiDynix