API Docs

Rest Item Loan

Overview

Data Dictionary

Click here to download rest_item_loan.xsd

item_loan

Description:

FieldTypeDescription
loan_idstringIdentifier of the loan in Alma. Should be used in subsequent queries regarding the loan.
circ_deskstring with attr. The circulation desk code that is responsible for the loan. Mandatory.
The valid values for this parameter are the circ_desk codes. These are the currently defined values for your institution:
CodeDescription
return_circ_deskstring with attr. The circulation desk code where the item was returned.
The valid values for this parameter are the circ_desk codes. These are the currently defined values for your institution:
CodeDescription
librarystring with attr. The library code that is responsible of the loan. Mandatory.
The valid values for this parameter are the library codes. These are the currently defined values for your institution:
CodeDescription
user_idstringThe loaning user identifier. Output parameter.
item_barcodestringThe barcode of the loaned item. Output parameter.
due_datedateTimeThe loan's due date. Can be modified using PUT or the renew API.
loan_statusloan_statusThe loan's status. Output parameter.
Possible values are: Active, Complete (for loan that has been returned ).
loan_datedateTimeThe date in which the loan took place. Output parameter. In the POST loan action, Alma populate this field with the
current date and time.
return_datedateTimeThe date in which the loan was returned. Output parameter.
returned_bystring with attr. The returning user identifier. Output parameter.
process_statusstringThe loan's process status. Output parameter. Possible codes are listed in 'Loan Process Status Search Column' code-table.

The valid values for this parameter are controlled by the code-table: HItemLoan.processStatus. These are the currently defined values for your institution:
CodeDescription
mms_idstringBibliographic record identifier. Output parameter.
holding_idstring
Holdings id that the item is associated with. Output parameter.
item_idstringPhysical item pid of the item. Output parameter
titlestringThe title of the loaned item. Output parameter.
authorstringThe author of the loaned item. Output parameter.
descriptionstringThe description of the loaned item when dealing with multi volume/issue item. Output parameter.
publication_yearnumericStringThe year of publication of the loaned item. Digits only. Output parameter.
location_codestring with attr. The current loacation of the item. Output parameter.
item_policystring with attr. The item's related policy. Output parameter. Possible codes are listed in 'Item Policy' code-table.
The valid values for this parameter are controlled by the code-table: ItemPolicy. These are the currently defined values for your institution:
CodeDescription
call_numberstringThe call number of the loaned item. Output parameter.
loan_finefloatThe amount that would be charged if the item would have been returned now (for example, if the loan is overdue). Output
parameter.
request_idstring with attr.
Internal identifier of the related request in Alma, generated by Alma.
Should be used in subsequent queries regarding the request.
See GET user's request API.
renewablebooleanFlag that indicates if the loan is renewable.
last_renew_datedateTimeThe loan's last renew date. Output parameter.
last_renew_statusstring with attr. The result of the last attempt to renew the loan. Output parameter. Some (but not all) of the possible codes are listed in 'MashUpLabels' code-table.

 

numericString
numericString is a xs:string with xs:restriction - see XSD for details.
loan_status
loan_status is a xs:string with xs:restriction - see XSD for details.

Samples

XML
JSON
__