Services and Operations > Patron service > lookupPatronInfo

lookupPatronInfo

The lookupPatronInfo operation allows you to retrieve information about a specified user’s account and account activity.

This is a privileged operation.

Synopsis

Service

Patron service

Namespace

http://schemas.sirsidynix.com/symws/patron

Prerequisites

Valid clientID (see clientID)
Valid sessionToken (see Authenticated operations) from user whose user access includes Display2 User Command Code.

Request

LookupPatronInfoRequest

Response

LookupPatronInfoResponse

Operation faults

None (see Faults)

LookupPatronInfoRequest

The LookupPatronInfoRequest has the following request parameters:

Parameter

Type

Description

Required?

userID, alternateID, and webAuthID are a choice. Specify a value for only one of them.

userID

xs:string

Specifies the user ID of the patron to look up information about.

Note: You only need to specify a userID, alternateID, or webAuthID. If you do not specify a userID, you must specify either an alternateID or webAuthID.

Y

alternateID

xs:string

Specifies the alternate ID of the patron to look up information about.

Note: You only need to specify a userID, alternateID, or webAuthID. If you do not specify an alternateID, you must specify either a userID or webAuthID.

webAuthID

xs:string

Specifies the web auth ID of the patron to look up information about.

Note: You only need to specify a userID, alternateID, or webAuthID. If you do not specify a webAuthID, you must specify either a userID or alternateID.

includePatronInfo

xs:boolean

Specifies if you want to include patron information in the response (true) or not (false).

Note: If you do not specify to includePatronInfo, the system will assume “false” by default.

N

includePatronCirculationInfo

xs:boolean

Specifies if you want to include patron circulation information in the response (true) or not (false).

Note: If you do not specify to includePatronCirculationInfo, the system will assume “false” by default.

N

includePatronAddressInfo

xs:boolean

Specifies if you want to include patron address information in the response (true) or not (false).

Note: If you do not specify to includePatronAddressInfo, the system will assume “false” by default.

N

includePatronCheckoutInfo

CheckoutInfoFilter

Specifies an enumeration value that limits the patron checkout information you receive in the response.

For example, specify OVERDUE as the value in order to only include information about checked out items that are overdue.

N

includePatronCheckoutHistoryInfo

xs:boolean

Specifies if you want to include the patron's checkout history in the response (true) or not (false).

Note: If you do not specify to includePatronCheckoutHistoryInfo, the system will assume “false” by default.

N

includePatronHoldInfo

HoldInfoFilter

Specifies an enumeration value that limits the patron hold information you receive in the response.

N

includeFeeInfo

FeeInfoFilter

Specifies an enumeration value that limits the fee information you receive in the response.

N

includePatronStatusInfo

xs:boolean

Specifies if you want to include patron information in the response (true) or not (false).

Note: If you do not specify to includePatronStatusInfo, the system will assume “false” by default.

N

includeUserGroupInfo

xs:boolean

Specifies if you want to include user group information in the response (true) or not (false).

Use the isUserGroupsEnabled operation to verify that User Groups are enabled in the ILS.

Note: If you do not specify to includeUserGroupInfo, the system will assume “false” by default.

N

includeUserSuspensionInfo

xs:boolean

Specifies if you want to include information pertaining to a user's suspension in the response (true) or not (false).

Note: If you do not specify to includeUserSuspensionInfo, the system will assume “false” by default.

N

includeSMSInfo

xs:boolean

Specifies if you want to include information about a patron's SMS phone numbers and preferences in the response (true) or not (false). For more information, see “SMS Notifications” in the Java WorkFlows help.

Note: If you do not specify to includeSMSInfo, the system will assume “false” by default.

N

LookupPatronInfoResponse

The LookupPatronInfoResponse returns the following elements:

Element

Type

Occ.

Description

patronInfo

PatronInfo

0..1

Displays information about a patron.

patronInfo is returned only if includePatronInfo is true.

patronCirculationInfo

PatronCirculationInfo

0..1

Displays specific circulation information for a patron.

patronCirculationInfo is returned only if includePatronCirculationInfo is true.

patronAddressInfo

PatronAddressInfo

0..1

Displays address information for a patron.

patronAddressInfo is returned only if includePatronAddressInfo is true.

patronCheckoutInfo

PatronCheckoutInfo

0..*

Displays specific checkout information for a patron.

patronCheckoutInfo is returned only if you enter an includePatronCheckoutInfo value.

patronCheckoutHistoryInfo

PatronCheckoutHistoryInfo

0..*

Displays specific checkout history information for a patron.

patronCheckoutHistoryInfo is returned only if includePatronCheckoutHistoryInfo is true.

patronHoldInfo

PatronHoldInfo

0..*

Displays specific hold information for a patron.

patronHoldInfo is returned only if you enter an includePatronHoldInfo value.

feeInfo

FeeInfo

0..*

Displays information about a patron’s fees and bills.

feeInfo is returned only if you enter an includePatronFeeInfo value.

patronStatusInfo

PatronStatusInfo

0..1

Displays information specific to a patron’s status.

patronStatusInfo is returned only if includePatronStatusInfo is true.

groupInfo

GroupInfo

0..1

Displays information about a patron's user group, information about the user group transactions (including holds for each user, charges/checkouts for each user, and bills for each user) and additionally retrieve the group permissions a user has pertaining to their group, group member information, and other miscellaneous information pertaining to the group.

userGroupInfo is returned only if includeUserGroupInfo is true.

userSuspensionInfo

UserSuspensionInfo

0..1

Displays information about a patron's suspension.

userSuspensionInfo is returned only if includeSuspensionInfo is true.

smsInfo

SMSInfo

0..*

Displays information about a patron's SMS preferences and phone numbers to use for SMS messaging.

smsInfo is returned only if includeSMSInfo is true.

Related topics 

 


© 2009-2012 SirsiDynix