Services and Operations > Patron service > modifyMyHold

modifyMyHold

The modifyMyHold operation allows you to modify certain hold values for a current session user’s hold.

Synopsis

Service

Patron service

Namespace

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

Prerequisites

Valid clientID (see clientID)

Request

ModifyMyHoldRequest

Response

ModifyMyHoldResponse

Operation faults

None (see Faults)

ModifyMyHoldRequest

The ModifyMyHoldRequest has the following request parameters:

Parameter

Type

Description

Required?

holdKey

xs:long

Specifies the hold key for the hold being modified.

Y

expiresDate

NillableDate

Specifies the hold expiration date.

You can specify a value that will override what is existing, or you can specify to nullify the existing date entirely.

If you do not specify an expiresDate value, the expiresDate will be calculated by the ILS.

N

holdPickupLibraryID and mailDeliveryID are a choice. Specify a value for one or the other.

holdPickupLibraryID

xs:string

Specifies the Library ID for the library if the hold will be picked up by the patron.

Note: If you enter a holdPickupLibraryID, do not specify a mailDeliveryID.

Note: If you enter a holdPickupLibraryID and the ILS is not config.multi (that is, it is a single-library instance), the request will succeed even though no change is made.

N

mailDeliveryID

xs:string

Specifies the Mail Service Tracking ID if the hold will be delivered by mail.

Note: If you enter a mailDeliveryID, do not specify a holdPickupLibraryID.

ModifyMyHoldResponse

The ModifyMyHoldResponse is boolean (see xs:boolean). The output will be true if the request to modify a hold was successful, and false if it was not.

A fault will be thrown if the user attempting to modify a hold does not own the hold reference by the supplied holdKey.

Related topics 

 


© 2009-2012 SirsiDynix