API Docs
Rest Item
Contents
Overview
An object representation of a Physical Item's data.
Data Dictionary
Click here to download rest_item.xsd
item
Description: A Physical item.
| Field | Type | Description |
|---|---|---|
bib_ | bib_data | Bibliographic data of the Physical Item. Output parameter. |
holding_ | holding_data | Information of the Holding that this Physical Item belongs to. |
item_ | item_data | Physical Item data. |
additional_ | string | Additional information following an action on the item. Output parameter. |
bib_data
Description: Bibliographic data of the Physical Item. Output parameter.
| Field | Type | Description |
|---|---|---|
mms_ | string | mms_id. Output parameter. |
bib_ | string | Indication whether the bib record should be published to Primo. Output parameter. |
title | string | The title of the Bibliographic record to which this Physical Item relates. Output parameter. |
author | string | author |
issn | string | issn. Output parameter. |
isbn | string | isbn. Output parameter. |
complete_ | string | Complete edition. Output parameter. |
network_ | network_numbers | Network number, control number. Output parameter. |
place_ | string | Place of publication, part of the imprint information. Output parameter. |
date_ | string | Date of publication. Output parameter. |
publisher_ | string | Publisher_const, part of the imprint information. Output parameter. |
holding_data
Description: Information of the Holding that this Physical Item belongs to.
| Field | Type | Description | ||
|---|---|---|---|---|
holding_ | string | Holding pid, a unique holding id that the item is associated with. Currently, cannot be updated for an existing item. | ||
holding_ | string | Indication whether the holding record should be published to Primo. Output parameter. | ||
calculated_ | string | Indication whether the record should be published to Primo. Note that this field might be true even when suppress_from_publishing is false. This is, for example, if the entire location has been suppressed. Output parameter. | ||
permanent_ | string with attr. | The call number type for permanent_call_number. Possible codes are listed in 'CallNumberType' code-table.
| ||
permanent_ | string | The call number of the holdings record that the item officially belongs to. Output parameter. | ||
call_ | string with attr. | The call number type for the call_number field. Possible codes are listed in 'CallNumberType' code-table.
| ||
call_ | string | The current call number, effective for the item. When the item is in a temporary location it will change accordingly. Output parameter. | ||
accession_ | string | accession number. Output parameter. | ||
copy_ | string | The item's copy ID, used to identify individual copies of the same title when multiple copies exist at the same location. | ||
in_ | boolean | Indicates 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_ | string with attr. | Temporary library. Relevant only if in_temp_location is True. | ||
temp_ | string with attr. | Temporary location. Relevant only if in_temp_location is True. | ||
temp_ | string 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.
| ||
temp_ | string | The item's call number when the items is at a temporary location. Relevant when in_temp_location=true. | ||
temp_ | string | The call number source that is equivalent to the $2 in the holdings record. | ||
temp_ | string with attr. | The item's temporary override policy. Possible codes are listed in 'ItemPolicy' code table. Relevant only if in_temp_location is True.
| ||
due_ | date | The date the item is due back from the temporary location. Relevant only if in_temp_location is True. |
item_data
Description: Physical Item data.
| Field | Type | Description | ||
|---|---|---|---|---|
pid | string | Physical item pid. Output parameter. | ||
barcode | string | The 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_ | date | The date the item was created. Output parameter. | ||
modification_ | date | The date the item was modified. Output parameter. | ||
base_ | string with attr. |
| ||
awaiting_ | boolean | Indicates whether the item is currently waiting to be reshelved, according to the library/circulation desk/reshelve without transit rule definitions. | ||
reshelving_ | dateTime | Indicates the time when the item will be reshelved, according to the library/circulation desk/reshelve without transit rule definitions. | ||
physical_ | string with attr. | The item's physical form, such as a book or CD-ROM. Possible codes are listed in 'PhysicalMaterialType' code table.
| ||
policy | string 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.
| ||
provenance | string with attr. | The item's origin. Possible codes are listed in 'provenanceCodes' code table.
| ||
po_ | string | 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_ | date | The issue date generated from a prediction pattern. | ||
is_ | boolean | Indicates 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_ | date | The date the material was actually received/activated for the first time. | ||
expected_ | date | The date the item was expected to be received. | ||
year_ | string | The related year for an issue item. | ||
enumeration_ | string | enumeration A | ||
enumeration_ | string | enumeration B | ||
enumeration_ | string | enumeration C | ||
enumeration_ | string | enumeration D | ||
enumeration_ | string | enumeration E | ||
enumeration_ | string | enumeration F | ||
enumeration_ | string | enumeration G | ||
enumeration_ | string | enumeration H | ||
chronology_ | string | chronology I | ||
chronology_ | string | chronology J | ||
chronology_ | string | chronology K | ||
chronology_ | string | chronology L | ||
chronology_ | string | chronology M | ||
break_ | string 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.
| ||
pattern_ | string with attr. | A valid 85X field from the item's holdings record. | ||
linking_ | string | A valid subfield $8 from the 85X field in pattern_type. | ||
type_ | string | The FIRST subfield $o of the relevant Pattern Type and Linking Number. Output parameter. | ||
description | string | This item's description. | ||
replacement_ | float | The charge administered to the patron if the item is lost. | ||
receiving_ | string | The Operator who received the item. | ||
process_ | string with attr. | Process type. Possible codes are listed in 'PROCESSTYPE' code table.
| ||
work_ | string with attr. | The code of the work order type. Relevant when process_type=WORK_ORDER_DEPARTMENT. | ||
work_ | string 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_ | string | The number of this physical item. | ||
inventory_ | date | The date the item was modified. | ||
inventory_ | string | The price of the item. The value is assumed to be in the default currency for your institution. | ||
receive_ | string | The number of this physical item receive. | ||
weeding_ | string | The number of this physical item weeding. | ||
weeding_ | date | The date the item was weeded. | ||
library | string 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
| ||
location | string 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_ | string | The call number indicated on the item. | ||
alternative_ | string with attr. | The type for alternative_call_number. Possible codes are listed in 'CallNumberType' code table.
| ||
alt_ | string | The ID number for the item that corresponds to the alternative call number type. | ||
storage_ | string | The ID number of the location where the item is stored. | ||
pages | string | The item's number of pages. | ||
pieces | string | The item's number of pieces. | ||
public_ | string | Contains note content that is displayed in Primo. | ||
fulfillment_ | string | Contains note content that is displayed during the circulation process. | ||
due_ | dateTime | The item's due date. If not on loan - empty. This field will be populated only if the 'expand' query parameter is sent. | ||
due_ | string | The loan policy as displayed in discovery. This field will be populated only if the 'expand' query parameter is sent. | ||
internal_ | string | Contains note content regarding an item for internal use by Alma staff. | ||
internal_ | string | Contains note content regarding an item for internal use by Alma staff. | ||
internal_ | string | Contains note content regarding an item for internal use by Alma staff. | ||
statistics_ | string | Contains note content that is exposed in analytics. | ||
statistics_ | string | Contains note content that is exposed in analytics. | ||
statistics_ | string | Contains note content that is exposed in analytics. | ||
requested | boolean | Indication whether item is requested or not. Output parameter. | ||
edition | string | Edition of the item. Output parameter. Returned only when view=label. | ||
imprint | string | Imprint of the item. Output parameter. Returned only when view=label. | ||
language | string | Language of the item. Output parameter. Returned only when view=label. | ||
library_ | library_details | Information regarding the item's owning library. Output parameter. Returned only when view=label. | ||
parsed_ | parsed_alt_call_number | Parsing information for the alternative call number. Output parameter. Returned only when view=label. | ||
parsed_ | parsed_call_number | Parsing information for the call number. Output parameter. Returned only when view=label. | ||
parsed_ | parsed_issue_level_description | Parsing information for the description. Output parameter. Returned only when view=label. | ||
title_ | string | Output parameter. Returned only when view=label. | ||
physical_ | string with attr. | The physical condition of the item. Usually used to note less than ideal condition. Possible codes are listed in 'ItemPhysicalCondition' code table.
| ||
committed_ | string 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.
| ||
retention_ | string with attr. | The reason for the retention. Possible codes are listed in the 'Retention Reason' code table.
| ||
retention_ | string | Contains 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.
| Field | Type | Description |
|---|---|---|
address | library_address | The 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.
| Field | Type | Description | ||
|---|---|---|---|---|
line1 | string | Line 1 of the address. Output parameter. Returned only when view=label. | ||
line2 | string | Line 2 of the address. Output parameter. Returned only when view=label. | ||
line3 | string | Line 3 of the address. Output parameter. Returned only when view=label. | ||
line4 | string | Line 4 of the address. Output parameter. Returned only when view=label. | ||
line5 | string | Line 5 of the address. Output parameter. Returned only when view=label. | ||
city | string | The relevant city. Output parameter. Returned only when view=label. | ||
country | string with attr. | The address' relevant country. Possible codes are listed in the 'Country Codes' code table. Output parameter. Returned only when view=label.
| ||
email | string | Output parameter. Returned only when view=label. | ||
phone | string | Output parameter. Returned only when view=label. | ||
postal_ | string | The address' relevant postal code. Output parameter. Returned only when view=label. | ||
state | string | The address' relevant state. Output parameter. Returned only when view=label. |
parsed_alt_call_number
Description:
| Field | Type | Description |
|---|---|---|
alt_ | string |
parsed_call_number
Description:
| Field | Type | Description |
|---|---|---|
call_ | string |
parsed_issue_level_description
Description:
| Field | Type | Description |
|---|---|---|
issue_ | string |
Samples
XML
JSON
__