Services and Operations > Patron service > suspendMyHold

suspendMyHold

The suspendMyHold operation allows you to suspend a current session user’s hold.

Synopsis

Service

Patron service

Namespace

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

Prerequisites

Valid clientID (see clientID)

Request

SuspendMyHoldRequest

Response

SuspendMyHoldResponse

Operation faults

None (see Faults)

SuspendMyHoldRequest

The SuspendMyHoldRequest has the following request parameters:

Parameter

Type

Description

Required?

holdKey

xs:long

Specifies the hold key for the item on hold.

Y

suspendStartDate

xs:date

Specifies the start date for the hold suspension.

Note: The suspendStartDate must be after the current date, and no later than the hold expiration date.

Y

suspendEndDate

xs:date

Specifies the date the hold suspension ends.

Note: The suspendEndDate must not be later than the hold expiration date.

N

SuspendMyHoldResponse

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

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

Related topics 

 


© 2009-2012 SirsiDynix