API Docs

Rest Item Loan

Overview

Data Dictionary

Click here to download rest_item_loan.xsd

item_loan

Description:

Field	Type	Description
loan_id	string	Identifier of the loan in Alma. Should be used in subsequent queries regarding the loan.
circ_desk	string 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: Code Description
return_circ_desk	string 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: Code Description
library	string 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: Code Description
user_id	string	The loaning user identifier. Output parameter.
item_barcode	string	The barcode of the loaned item. Output parameter.
due_date	dateTime	The loan's due date. Can be modified using PUT or the renew API.
loan_status	loan_status	The loan's status. Output parameter. Possible values are: Active, Complete (for loan that has been returned ).
loan_date	dateTime	The 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_date	dateTime	The date in which the loan was returned. Output parameter.
returned_by	string with attr.	The returning user identifier. Output parameter.
process_status	string	The 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: Code Description
mms_id	string	Bibliographic record identifier. Output parameter.
holding_id	string	Holdings id that the item is associated with. Output parameter.
item_id	string	Physical item pid of the item. Output parameter
title	string	The title of the loaned item. Output parameter.
author	string	The author of the loaned item. Output parameter.
description	string	The description of the loaned item when dealing with multi volume/issue item. Output parameter.
publication_year	numericString	The year of publication of the loaned item. Digits only. Output parameter.
location_code	string with attr.	The current loacation of the item. Output parameter.
item_policy	string 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: Code Description
call_number	string	The call number of the loaned item. Output parameter.
loan_fine	float	The amount that would be charged if the item would have been returned now (for example, if the loan is overdue). Output parameter.
request_id	string 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.
renewable	boolean	Flag that indicates if the loan is renewable.
last_renew_date	dateTime	The loan's last renew date. Output parameter.
last_renew_status	string 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

__