Services and Operations > Patron service

Patron service

The Patron service includes operations that a patron can do for themselves. Operations in this service can only be performed on the user record for the patron that is logged in.

The Patron service includes these operations (listed alphabetically):

Operation

Description

activateOnlineRegisteredUser

Activates a user who completed online user registration.

changeMyAlternativeID

Specifies a new Alternative User ID for the session user.

cancelMyHold

Cancels a hold for the specified item or title for the session user.

changeMyPIN

Specifies a new PIN for the session user.

createMyHold

Creates a hold for the specified item or title for the session user. Returns only a hold key. Compare with placeMyHold.

createMySMSEntry

Creates a new SMS number and configuration for the session user.

createSelfRegisteredPatron

Creates a new patron record based on rules in the Online User Registration setup. The Online User Registration feature of the ILS must be enabled and properly configured to use this operation.

deleteMyList

Deletes the specified permanent list for the session user.

deleteMySMSEntry

Deletes the specified SMS entry or entries for the session user.

enableMyCheckoutHistory

Specifies whether to enable or disable the keeping of circulation history for the patron.

getMyList

Retrieves the specified permanent list in a format suitable for updating data with saveMyList.

lookupMyAccountInfo

Retrieves information about the current session user’s account and account activity.

lookupMyList

Displays the specified permanent list for the session user; optionally includes brief title information for each title in the list.

lookupMyLists

Displays a list of the session user’s permanent lists.

lookupPatronInfo

Retrieves information about a specified user’s account and account activity.

modifyMyHold

Lets you change the expiration date of the specified hold or specify a pickup library or mail service (if holds by mail is enabled in the ILS). If you specify a mail service, the hold is automatically flagged for mail delivery. If you specify a pickup library, the mail flag is cleared.

placeMyHold

Creates a hold for the specified item or title for the session user. Returns a hold key and other hold information. Compare with createMyHold.

renewMyCheckout

Renews the specified item for the session user.

saveMyList

Allows you to save a new or updated My List for the current session user.

suspendMyHold

Suspends the specified hold for the duration you specify by start and end date.

The ILS validates dates. For example, the start or end date cannot be later than the hold expiration date. Consult with the library system administrator for information about what rules the ILS uses for dates.

unsuspendMyHold

Activates the specified hold if it is currently suspended (it clears the suspension start and end dates).

updateMySMSEntry

Updates an existing SMS number and configuration for the session user.

Related topics 

 


© 2009-2012 SirsiDynix