The placeMyHold operation allows you to make a hold for the current session user and to get back information about the request.
This operation is different than the createMyHold operation, which only returns the hold key.
Synopsis
Service |
||||
Namespace |
http://schemas.sirsidynix.com/symws/patron |
|||
Prerequisites |
|
|||
Request |
||||
Response |
||||
Operation faults |
None (see Faults) |
The PlaceMyHoldRequest has the following request parameters:
Parameter |
Type |
Description |
Required? |
itemID and titleKey are a choice. Specify a value for one or the other. |
|||
Specifies the item ID for the item being placed on hold. Note: Only specify an itemID or a titleKey. Do not specify both. |
Y |
||
Specifies the titleKey for the item being placed on hold. Note: Only specify a titleKey or an itemID. Do not specify both. |
|||
Specifies the call number for the item being placed on hold. This is mainly used for placing volume-level holds. For information about how to determine whether this is needed, see Volume holds. |
N |
||
Specifies the enumerated hold type value. If you do not specify a holdType value, the system assumes TITLE by default. |
N |
||
Specifies the enumerated hold range value. If you do not specify a holdRange value, the system assumes GROUP by default. |
N |
||
pickupLibraryID and mailServiceID are a choice. Specify a value for one or the other. |
|||
Specifies the pickup library Library ID if the hold will be picked up by the patron. Note: Do not specify a pickupLibraryID if you specify a mailServiceID. |
Y |
||
Specifies the Mail Service Tracking ID if the hold will be delivered by mail. Note: Do not specify a mailServiceID if you specify a pickupLibraryID. |
|||
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 |
||
Specifies the start date of the hold suspension. |
N |
||
Specifies the date the hold suspension ends. |
N |
||
Specifies optional text to display with the hold information. |
N |
The PlaceMyHoldResponse returns the following elements:
Element |
Type |
Occ. |
Description |
1 |
Displays the hold key for the request. |
||
0..1 |
Displays the estimated fee assessed, if any, for placing a hold on the item. |
||
0..1 |
Displays the title of the hold request. |
||
0..1 |
Displays the author of the hold request. |
||
1 |
Displays whether the item requested is currently available. |
||
1 |
Displays the call number of the item. |
||
0..1 |
Displays the item ID for the hold request item. |
||
0..1 |
Displays the date the hold request expires. |
||
0..1 |
Displays the date on or by which the user must pick up the available hold before it expires on the Holds shelf. |
Related topics
© 2009-2012 SirsiDynix