Short Loan per Item
General Purpose
The resource may be accessed with a GET method to retrieve the short loan infomation for a specific patron and item. The short loan request information includes a list of the requestable slots. The start and end time of each slot is reported, as well as the number of requests that may be placed on each slot and how many requests have already been place on it.
The resource may be accessed with a PUT method to create a short loan request for a specific patron on a specific item.
Product Version Compatibility
Versions 18, 20.1 and later
Interface Type
RESTful API
Hierarchy
Input Parameters
REST Resource IDs:
Patron ID: The Aleph patron system identifier.
Record ID: The Aleph BIB record identifier. The identifier is composed of the BIB library code + the system number. For example, USM01000028084
Item ID: The Aleph item record identifier. The item ID may be used to fetch a specific item’s information. The identifier is composed of the ADM library code + the item record key. For example, USM50000028084000020.
URL Parameters:
offset: The number of days for which slots will be displayed, starting from the current date or from the date supplied in the date parameter. Optional.
date: Slots will be reported starting from this date. The date is specified in yyyymmdd format. Optional.
startDays: A Y\N parameter. When used with Y an additioanl repetitive slot-start-day element will be used to list all of the days on which a slot starts, starting the current date or from the date supplied in the date parameter. Optional.
Input URI
<Base URL>:/patron/<patron ID>/record/<record ID>/items/<Item ID>/shortLoan
For example:
To retrieve the short loan request information for a specific item that belongs to BIB record 00028084 and for the patron ID 00000036, use:
Input XML
To create a new item level short loan request, use the same URL with a PUT method of HTTP.
The request “Body” of the “PUT” method must contain input XML with the “Short Loan” request details.
The PUT XML must have the following structure:
post_xml=<short-loan-parameters><request-slot>Slot ID</request-slot></short-loan-parameters>
The slot ID is the ID that is reported in the id attribute of the slot element in the GET reply. For example, 201109011700.
Note the “post_xml=” on start.
Output XML Format
The returned XML includes the short loan information.
For example:
<?xml version="1.0" encoding="UTF-8"?>
<get-item-short>
<reply-text>ok</reply-text>
<reply-code>0000</reply-code>
<short-loan allowed="Y">
<request-slot usage="Mandatory"/>
<slot id="201401070800">
<start>
<date>20140107</date>
<hour>0800</hour>
</start>
<end>
<date>20140107</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401071100">
<start>
<date>20140107</date>
<hour>1100</hour>
</start>
<end>
<date>20140107</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401071300">
<start>
<date>20140107</date>
<hour>1300</hour>
</start>
<end>
<date>20140107</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401071500">
<start>
<date>20140107</date>
<hour>1500</hour>
</start>
<end>
<date>20140107</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401071700">
<start>
<date>20140107</date>
<hour>1700</hour>
</start>
<end>
<date>20140107</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401071900">
<start>
<date>20140107</date>
<hour>1900</hour>
</start>
<end>
<date>20140108</date>
<hour>0900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401080900">
<start>
<date>20140108</date>
<hour>0900</hour>
</start>
<end>
<date>20140108</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401081100">
<start>
<date>20140108</date>
<hour>1100</hour>
</start>
<end>
<date>20140108</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401081300">
<start>
<date>20140108</date>
<hour>1300</hour>
</start>
<end>
<date>20140108</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401081700">
<start>
<date>20140108</date>
<hour>1700</hour>
</start>
<end>
<date>20140108</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401081900">
<start>
<date>20140108</date>
<hour>1900</hour>
</start>
<end>
<date>20140109</date>
<hour>0900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401090900">
<start>
<date>20140109</date>
<hour>0900</hour>
</start>
<end>
<date>20140109</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401091100">
<start>
<date>20140109</date>
<hour>1100</hour>
</start>
<end>
<date>20140109</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401091300">
<start>
<date>20140109</date>
<hour>1300</hour>
</start>
<end>
<date>20140109</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401091500">
<start>
<date>20140109</date>
<hour>1500</hour>
</start>
<end>
<date>20140109</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401091700">
<start>
<date>20140109</date>
<hour>1700</hour>
</start>
<end>
<date>20140109</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401091900">
<start>
<date>20140109</date>
<hour>1900</hour>
</start>
<end>
<date>20140110</date>
<hour>0900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401100900">
<start>
<date>20140110</date>
<hour>0900</hour>
</start>
<end>
<date>20140110</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401101100">
<start>
<date>20140110</date>
<hour>1100</hour>
</start>
<end>
<date>20140110</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401101300">
<start>
<date>20140110</date>
<hour>1300</hour>
</start>
<end>
<date>20140110</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401101500">
<start>
<date>20140110</date>
<hour>1500</hour>
</start>
<end>
<date>20140110</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401101700">
<start>
<date>20140110</date>
<hour>1700</hour>
</start>
<end>
<date>20140110</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401110800">
<start>
<date>20140111</date>
<hour>0800</hour>
</start>
<end>
<date>20140112</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401121300">
<start>
<date>20140112</date>
<hour>1300</hour>
</start>
<end>
<date>20140112</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401121700">
<start>
<date>20140112</date>
<hour>1700</hour>
</start>
<end>
<date>20140114</date>
<hour>0800</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401140800">
<start>
<date>20140114</date>
<hour>0800</hour>
</start>
<end>
<date>20140114</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401141100">
<start>
<date>20140114</date>
<hour>1100</hour>
</start>
<end>
<date>20140114</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401141300">
<start>
<date>20140114</date>
<hour>1300</hour>
</start>
<end>
<date>20140114</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401141500">
<start>
<date>20140114</date>
<hour>1500</hour>
</start>
<end>
<date>20140114</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401141700">
<start>
<date>20140114</date>
<hour>1700</hour>
</start>
<end>
<date>20140114</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401141900">
<start>
<date>20140114</date>
<hour>1900</hour>
</start>
<end>
<date>20140115</date>
<hour>0900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401150900">
<start>
<date>20140115</date>
<hour>0900</hour>
</start>
<end>
<date>20140115</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401151100">
<start>
<date>20140115</date>
<hour>1100</hour>
</start>
<end>
<date>20140115</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401151300">
<start>
<date>20140115</date>
<hour>1300</hour>
</start>
<end>
<date>20140115</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401151700">
<start>
<date>20140115</date>
<hour>1700</hour>
</start>
<end>
<date>20140115</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401151900">
<start>
<date>20140115</date>
<hour>1900</hour>
</start>
<end>
<date>20140116</date>
<hour>0900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401160900">
<start>
<date>20140116</date>
<hour>0900</hour>
</start>
<end>
<date>20140116</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401161100">
<start>
<date>20140116</date>
<hour>1100</hour>
</start>
<end>
<date>20140116</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401161300">
<start>
<date>20140116</date>
<hour>1300</hour>
</start>
<end>
<date>20140116</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401161500">
<start>
<date>20140116</date>
<hour>1500</hour>
</start>
<end>
<date>20140116</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401161700">
<start>
<date>20140116</date>
<hour>1700</hour>
</start>
<end>
<date>20140116</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401161900">
<start>
<date>20140116</date>
<hour>1900</hour>
</start>
<end>
<date>20140117</date>
<hour>0900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401170900">
<start>
<date>20140117</date>
<hour>0900</hour>
</start>
<end>
<date>20140117</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401171100">
<start>
<date>20140117</date>
<hour>1100</hour>
</start>
<end>
<date>20140117</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401171300">
<start>
<date>20140117</date>
<hour>1300</hour>
</start>
<end>
<date>20140117</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401171500">
<start>
<date>20140117</date>
<hour>1500</hour>
</start>
<end>
<date>20140117</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401171700">
<start>
<date>20140117</date>
<hour>1700</hour>
</start>
<end>
<date>20140117</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401180800">
<start>
<date>20140118</date>
<hour>0800</hour>
</start>
<end>
<date>20140119</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401191300">
<start>
<date>20140119</date>
<hour>1300</hour>
</start>
<end>
<date>20140119</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401191700">
<start>
<date>20140119</date>
<hour>1700</hour>
</start>
<end>
<date>20140121</date>
<hour>0800</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401210800">
<start>
<date>20140121</date>
<hour>0800</hour>
</start>
<end>
<date>20140121</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401211100">
<start>
<date>20140121</date>
<hour>1100</hour>
</start>
<end>
<date>20140121</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401211300">
<start>
<date>20140121</date>
<hour>1300</hour>
</start>
<end>
<date>20140121</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401211500">
<start>
<date>20140121</date>
<hour>1500</hour>
</start>
<end>
<date>20140121</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401211700">
<start>
<date>20140121</date>
<hour>1700</hour>
</start>
<end>
<date>20140121</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401211900">
<start>
<date>20140121</date>
<hour>1900</hour>
</start>
<end>
<date>20140122</date>
<hour>0900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401220900">
<start>
<date>20140122</date>
<hour>0900</hour>
</start>
<end>
<date>20140122</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401221100">
<start>
<date>20140122</date>
<hour>1100</hour>
</start>
<end>
<date>20140122</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401221300">
<start>
<date>20140122</date>
<hour>1300</hour>
</start>
<end>
<date>20140122</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401221700">
<start>
<date>20140122</date>
<hour>1700</hour>
</start>
<end>
<date>20140122</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401221900">
<start>
<date>20140122</date>
<hour>1900</hour>
</start>
<end>
<date>20140123</date>
<hour>0900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401230900">
<start>
<date>20140123</date>
<hour>0900</hour>
</start>
<end>
<date>20140123</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401231100">
<start>
<date>20140123</date>
<hour>1100</hour>
</start>
<end>
<date>20140123</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401231300">
<start>
<date>20140123</date>
<hour>1300</hour>
</start>
<end>
<date>20140123</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401231500">
<start>
<date>20140123</date>
<hour>1500</hour>
</start>
<end>
<date>20140123</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401231700">
<start>
<date>20140123</date>
<hour>1700</hour>
</start>
<end>
<date>20140123</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401231900">
<start>
<date>20140123</date>
<hour>1900</hour>
</start>
<end>
<date>20140124</date>
<hour>0900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401240900">
<start>
<date>20140124</date>
<hour>0900</hour>
</start>
<end>
<date>20140124</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401241100">
<start>
<date>20140124</date>
<hour>1100</hour>
</start>
<end>
<date>20140124</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401241300">
<start>
<date>20140124</date>
<hour>1300</hour>
</start>
<end>
<date>20140124</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401241500">
<start>
<date>20140124</date>
<hour>1500</hour>
</start>
<end>
<date>20140124</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401241700">
<start>
<date>20140124</date>
<hour>1700</hour>
</start>
<end>
<date>20140124</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401250800">
<start>
<date>20140125</date>
<hour>0800</hour>
</start>
<end>
<date>20140126</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401261300">
<start>
<date>20140126</date>
<hour>1300</hour>
</start>
<end>
<date>20140126</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401261700">
<start>
<date>20140126</date>
<hour>1700</hour>
</start>
<end>
<date>20140128</date>
<hour>0800</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401280800">
<start>
<date>20140128</date>
<hour>0800</hour>
</start>
<end>
<date>20140128</date>
<hour>1100</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401281100">
<start>
<date>20140128</date>
<hour>1100</hour>
</start>
<end>
<date>20140128</date>
<hour>1300</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401281300">
<start>
<date>20140128</date>
<hour>1300</hour>
</start>
<end>
<date>20140128</date>
<hour>1500</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401281500">
<start>
<date>20140128</date>
<hour>1500</hour>
</start>
<end>
<date>20140128</date>
<hour>1700</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401281700">
<start>
<date>20140128</date>
<hour>1700</hour>
</start>
<end>
<date>20140128</date>
<hour>1900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
<slot id="201401281900">
<start>
<date>20140128</date>
<hour>1900</hour>
</start>
<end>
<date>20140129</date>
<hour>0900</hour>
</end>
<num-of-items>1</num-of-items>
<num-of-occupied>0</num-of-occupied>
</slot>
</short-loan>
</get-item-short>If a new request was successfully created using the POST method, a reply such as the following will be reported:
<?xml version="1.0" encoding="UTF-8"?>
<put-rec-short>
<reply-text>ok</reply-text>
<reply-code>0000</reply-code>
<create-short-loan>
<note type="info">Action Succeeded</note>
</create-short-loan>
</put-rec-short>Possible Error Codes
02 : The patron ID is invalid
19 : Record does not exist
25 : Failed to create request
27 : Item does not exist
31 : Invalid date parameter
32 : Date parameter is prior to current date
33 : Offset parameter is not numeric