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

PatronCirculationInfo

The PatronCirculationInfo type displays specific circulation information for a particular patron.

Ancestors

None

Relevant operations

lookupMyAccountInfo
lookupPatronInfo

Contents

This type has the following elements:

Element

Type

Occ.

Description

numberOfCheckouts

xs:int

1

Displays the number of items the patron has checked out.

numberOfClaimsReturned

xs:int

1

Displays the number of items the patron has claimed returned.

numberOfBookings

xs:int

1

Displays the number of bookings the patron has made.

numberOfRequests

xs:int

1

Displays the number of requests the patron has made.

numberOfUnansweredRequests

xs:int

1

Displays the number of unanswered requests the patron has made.

numberOfHolds

xs:int

1

Displays the number of holds the patron has made.

numberOfAvailableHolds

xs:int

1

Displays the number of holds that are available for pickup.

numberOfFees

xs:int

1

Displays the number of fees the patron has.

estimatedFines

Money

1

Displays an estimated monetary amount fined to the patron.

estimatedOverdues

xs:int

1

Displays an estimated number of items that are overdue.

creditBalance

Money

0..1

Displays the patron's credit balance.

This element is only returned if there is a credit balance.

checkoutHistoryRule

CheckoutHistoryRule

0..1

Displays information about how charge history is kept for a specific user.

checkoutHistoryRule is returned only if loan history is configured.

numberOfCheckoutsAllowed and numberOfCheckoutsAllowedUnlimited are a choice. Values will be returned for one element or the other.

numberOfCheckoutsAllowed

xs:int

1

Displays the number of checkouts allowed to the patron.

Note: The numberOfCheckoutsAllowed elements are a choice. If there is a value for numberOfCheckoutsAllowed, then numberOfCheckoutsAllowedUnlimited will not display.

numberOfCheckoutsAllowedUnlimited

xs:boolean

Displays “true” if the patron is allowed an unlimited amount of checkouts.

Note: The numberOfCheckoutsAllowed elements are a choice. If there is a value for numberOfCheckoutsAllowed, then numberOfCheckoutsAllowedUnlimited will not display.

 


© 2009-2012 SirsiDynix