API Docs

Rest Item

Overview

An object representation of a Physical Item's data.

Data Dictionary

Click here to download rest_item.xsd

item

Description: A Physical item.

FieldTypeDescription
bib_databib_dataBibliographic data of the Physical Item. Output parameter.
holding_dataholding_dataInformation of the Holding that this Physical Item belongs to.
item_dataitem_dataPhysical Item data.
additional_infostringAdditional information following an action on the item. Output parameter.

 

bib_data

Description: Bibliographic data of the Physical Item. Output parameter.

FieldTypeDescription
mms_idstringmms_id. Output parameter.
bib_suppress_from_publishingstringIndication whether the bib record should be published to Primo. Output parameter.
titlestringThe title of the Bibliographic record to which this Physical Item relates. Output parameter.
authorstringauthor
issnstringissn. Output parameter.
isbnstringisbn. Output parameter.
complete_editionstringComplete edition. Output parameter.
network_numbersnetwork_numbersNetwork number, control number. Output parameter.
place_of_publicationstringPlace of publication, part of the imprint information. Output parameter.
date_of_publicationstringDate of publication. Output parameter.
publisher_conststringPublisher_const, part of the imprint information. Output parameter.

 

holding_data

Description: Information of the Holding that this Physical Item belongs to.

FieldTypeDescription
holding_idstringHolding pid, a unique holding id that the item is associated with.
Currently, cannot be updated for an existing item.
holding_suppress_from_publishingstringIndication whether the holding record should be published to Primo. Output parameter.
permanent_call_number_typestring with attr. The call number type for permanent_call_number. Possible codes are listed in 'CallNumberType' code-table.

The valid values for this parameter are controlled by the code-table: CallNumberType. These are the currently defined values for your institution:
CodeDescription
permanent_call_numberstringThe call number of the holdings record that the item officially belongs to. Output parameter.
call_number_typestring with attr. The call number type for the call_number field. Possible codes are listed in 'CallNumberType' code-table.

The valid values for this parameter are controlled by the code-table: CallNumberType. These are the currently defined values for your institution:
CodeDescription
call_numberstringThe current call number, effective for the item. When the item is in a temporary location it will change accordingly. Output parameter.
accession_numberstringaccession number. Output parameter.
copy_idstringThe item's copy ID, used to identify individual copies of the same title when multiple copies exist at the same location.
in_temp_locationbooleanIndicates whether the item is currently in temporary location. Default is False.
In order to move an item to a temporary location use PUT to change this field to true and modify the temp_library and temp_location to the relevant codes.
temp_librarystring with attr. Temporary library.
Relevant only if in_temp_location is True.
temp_locationstring with attr. Temporary location.
Relevant only if in_temp_location is True.
temp_call_number_typestring with attr. The call number type used for temp_call_number.
Possible codes are listed in 'CallNumberType' code table.
Relevant when in_temp_location=true.

The valid values for this parameter are controlled by the code-table: CallNumberType. These are the currently defined values for your institution:
CodeDescription
temp_call_numberstringThe item's call number when the items is at a temporary location.
Relevant when in_temp_location=true.
temp_call_number_sourcestringThe call number source that is equivalent to the $2 in the holdings record.
temp_policystring with attr. The item's temporary override policy.
Possible codes are listed in 'ItemPolicy' code table.
Relevant only if in_temp_location is True.

The valid values for this parameter are controlled by the code-table: ItemPolicy. These are the currently defined values for your institution:
CodeDescription
due_back_datedateThe date the item is due back from the temporary location.
Relevant only if in_temp_location is True.

 

item_data

Description: Physical Item data.

FieldTypeDescription
pidstringPhysical item pid. Output parameter.
barcodestringThe item's barcode.
If not sent as part of the PUT or POST actions, Alma will generate a barcode based on the barcode generation rules.
creation_datedateThe date the item was created. Output parameter.
modification_datedateThe date the item was modified. Output parameter.
base_statusstring with attr.
The valid values for this parameter are controlled by the code-table: BaseStatus. These are the currently defined values for your institution:
CodeDescription
awaiting_reshelvingbooleanIndicates whether the item is currently waiting to be reshelved, according to the library/circulation desk/reshelve without transit rule definitions.
reshelving_timedateTimeIndicates the time when the item will be reshelved, according to the library/circulation desk/reshelve without transit rule definitions.
physical_material_typestring with attr. The item's physical form, such as a book or CD-ROM.
Possible codes are listed in 'PhysicalMaterialType' code table.

The valid values for this parameter are controlled by the code-table: PhysicalMaterialType. These are the currently defined values for your institution:
CodeDescription
policystring with attr. The item's override policy for loan rules.
Defines the conditions under which a request for this item can be fulfilled.
Possible codes are listed in 'ItemPolicy' 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
provenancestring with attr. The item's origin.
Possible codes are listed in 'provenanceCodes' code table.
The valid values for this parameter are controlled by the code-table: provenanceCodes. These are the currently defined values for your institution:
CodeDescription
po_linestring
The related PO line number.
In the GET action, this might be the matching holding's PO line (in case of continuous PO line).
In POST and PUT actions, it is possible to update only the specific item's PO line.
Hence, in case the PO line in this field is continuous, it will be ignored. Such an update should be done in the holding record itself.
issue_datedateThe issue date generated from a prediction pattern.
is_magneticbooleanIndicates whether the item contains a magnet which can cause it to be damaged when scanned by a self-check machine.
Optional. Default is False.
arrival_datedateThe date the material was actually received/activated for the first time.
expected_arrival_datedateThe date the item was expected to be received.
year_of_issuestringThe related year for an issue item.
enumeration_astringenumeration A
enumeration_bstringenumeration B
enumeration_cstringenumeration C
enumeration_dstringenumeration D
enumeration_estringenumeration E
enumeration_fstringenumeration F
enumeration_gstringenumeration G
enumeration_hstringenumeration H
chronology_istringchronology I
chronology_jstringchronology J
chronology_kstringchronology K
chronology_lstringchronology L
chronology_mstringchronology M
break_indicatorstring with attr. The code that indicates the reason for a break in the enumeration or chronology. Possible codes are listed in 'breakIndicatorCodes' code table. Relevant only if in_temp_location is True.
The valid values for this parameter are controlled by the code-table: breakIndicatorCodes. These are the currently defined values for your institution:
CodeDescription
pattern_typestring with attr. A valid 85X field from the item's holdings record.
linking_numberstringA valid subfield $8 from the 85X field in pattern_type.
type_of_unitstringThe FIRST subfield $o of the relevant Pattern Type and Linking Number. Output parameter.
descriptionstringThis item's description.
replacement_costfloatThe charge administered to the patron if the item is lost.
receiving_operatorstringThe Operator who received the item.
process_typestring with attr. Process type.
Possible codes are listed in 'PROCESSTYPE' code table.
The valid values for this parameter are controlled by the code-table: PROCESSTYPE. These are the currently defined values for your institution:
CodeDescription
work_order_typestring with attr.
The code of the work order type.
Relevant when process_type=WORK_ORDER_DEPARTMENT.
work_order_atstring with attr.
The code of the department that is handling the work order process.
Relevant when process_type= WORK_ORDER_DEPARTMENT.
A list of departments can be retrieved using GET /almaws/v1/conf/departments.
inventory_numberstringThe number of this physical item.
inventory_datedateThe date the item was modified.
inventory_pricestringThe price of the item. The value is assumed to be in
the default currency for your institution.
receive_numberstringThe number of this physical item receive.
weeding_numberstringThe number of this physical item weeding.
weeding_datedateThe date the item was weeded.
librarystring with attr. Library.
In PUT, updating the library and/or location might move the item to a different Holding record, or will create a new holding record for it.
In POST action the library will be defined according to the holding_id field.
see Get libraries API
The valid values for this parameter are the library codes. These are the currently defined values for your institution:
CodeDescription
locationstring with attr. Location.
In PUT, updating the library and/or location might move the item to a different Holding record, or will create a new holding record for it.
In POST action, will be defined according to the holding_id field.
see Get locations API
alternative_call_numberstringThe call number indicated on the item.
alternative_call_number_typestring with attr. The type for alternative_call_number.
Possible codes are listed in 'CallNumberType' code table.

The valid values for this parameter are controlled by the code-table: CallNumberType. These are the currently defined values for your institution:
CodeDescription
alt_number_sourcestringThe ID number for the item that corresponds to the alternative call number type.
storage_location_idstringThe ID number of the location where the item is stored.
pagesstringThe item's number of pages.
piecesstringThe item's number of pieces.
public_notestringContains note content that is displayed in Primo.
fulfillment_notestringContains note content that is displayed during the circulation process.
due_datedateTimeThe item's due date. If not on loan - empty. This field will be populated only if the 'expand' query parameter is sent.
due_date_policystringThe loan policy as displayed in discovery. This field will be populated only if the 'expand' query parameter is sent.
internal_note_1stringContains note content regarding an item for internal use by Alma staff.
internal_note_2stringContains note content regarding an item for internal use by Alma staff.
internal_note_3stringContains note content regarding an item for internal use by Alma staff.
statistics_note_1stringContains note content that is exposed in analytics.
statistics_note_2stringContains note content that is exposed in analytics.
statistics_note_3stringContains note content that is exposed in analytics.
requestedbooleanIndication whether item is requested or not. Output parameter.
editionstringEdition of the item. Output parameter. Returned only when view=label.
imprintstringImprint of the item. Output parameter.
Returned only when view=label.
languagestringLanguage of the item. Output parameter.
Returned only when view=label.
library_detailslibrary_detailsInformation regarding the item's owning library. Output parameter.
Returned only when view=label.
parsed_alt_call_numberparsed_alt_call_numberParsing information for the alternative call number. Output parameter.
Returned only when view=label.
parsed_call_numberparsed_call_numberParsing information for the call number. Output parameter.
Returned only when view=label.
parsed_issue_level_descriptionparsed_issue_level_descriptionParsing information for the description. Output parameter.
Returned only when view=label.
title_abcnphstringOutput parameter.
Returned only when view=label.
physical_conditionstring with attr. The physical condition of the item. Usually used to note less than ideal condition.
Possible codes are listed in 'ItemPhysicalCondition' code table.

The valid values for this parameter are controlled by the code-table: ItemPhysicalCondition. These are the currently defined values for your institution:
CodeDescription
committed_to_retainstring with attr. If true, this item is part of a collaborative collecting agreement and should not be deleted from this institution. NOTE: This field will only be available if a feature flag is set for Collaborative Collections.
The valid values for this parameter are controlled by the code-table: BooleanYesNo. These are the currently defined values for your institution:
CodeDescription
retention_reasonstring with attr. The reason for the retention. Possible codes are listed in the 'Retention Reason' code table.
The valid values for this parameter are controlled by the code-table: RetentionReason. These are the currently defined values for your institution:
CodeDescription
retention_notestringContains a note about the retention of this item.

 

library_details

Description: Information regarding the item's owning library. Output parameter.
Returned only when view=label.

FieldTypeDescription
addresslibrary_addressThe library's related address. Output parameter.
Returned only when view=label.

 

library_address

Description: The library's related address. Output parameter.
Returned only when view=label.

FieldTypeDescription
line1stringLine 1 of the address. Output parameter.
Returned only when view=label.
line2stringLine 2 of the address. Output parameter.
Returned only when view=label.
line3stringLine 3 of the address. Output parameter.
Returned only when view=label.
line4stringLine 4 of the address. Output parameter.
Returned only when view=label.
line5stringLine 5 of the address. Output parameter.
Returned only when view=label.
citystringThe relevant city. Output parameter.
Returned only when view=label.
countrystring with attr. The address' relevant country.
Possible codes are listed in the 'Country Codes' code table.
Output parameter. Returned only when view=label.

The valid values for this parameter are controlled by the code-table: CountryCodes. These are the currently defined values for your institution:
CodeDescription
emailstringOutput parameter.
Returned only when view=label.
phonestringOutput parameter.
Returned only when view=label.
postal_codestringThe address' relevant postal code. Output parameter.
Returned only when view=label.
statestringThe address' relevant state. Output parameter.
Returned only when view=label.

 

parsed_alt_call_number

Description:

FieldTypeDescription
alt_call_nostring

 

parsed_call_number

Description:

FieldTypeDescription
call_nostring

 

parsed_issue_level_description

Description:

FieldTypeDescription
issue_level_descriptionstring

 

Samples

XML
JSON
__