API Docs
External Sys Remote Storage Export Requests
Contents
Overview
When a resource request is placed on an item that belongs to a remote storage location, an automatic job exports the requested information to a defined FTP location.
The remote storage system then retrieves the file and processes it.
Data Dictionary
Click here to download external_sys_remote_storage_export_requests.xsd
rsExport
Description: Specific resource request to be processed by a remote storage system.
| Field | Type | Description |
|---|---|---|
requestType | string | Description of the request type in Alma. For information purpose only. |
requestId | string | The request identifier in Alma. |
pickup | exportPickup | The target Pickup Location. The remote storage system should send the item to this location for pickup. |
operationalRecordinformation | operationalRecordinformation | Additional information regarding the requested item. |
barcode | string | The barcode of the requested item. |
mmsId | string | The mms id of the requested item. |
itemId | string | The requested item's identifier in Alma. |
title | string | The title of the requested item. Will be added only if the system type configured in the Integration Profile is W.B. Meyer. |
copyId | string | The copy ID of the requested item. Will be added only if the system type configured in the Integration Profile is W.B. Meyer. |
description | string | The description of the requested item. Will be added only if the system type configured in the Integration Profile is W.B. Meyer. |
enumsAndChrons | enumsAndChrons | The Enum and Chron fields of the requested item. Will be added only if the system type configured in the Integration Profile is W.B. Meyer. |
requestedInfo | requestedInfo | Additional request information. |
patronInfo | patronInfo | Information regarding the requesting patron. Note that patron information will be added only for physical digitization requests and only if the "Handle digitization requests locally" flag is on in the remote storage configuration. In this case the patron information is needed in order to send the email to the patron from the remote storage. |
shipAddress | userAddress | Shipping Address of the target pickup location. Relevant only when the request is not for resource sharing. |
shipAddressPartner | userAddress | Shipping Address of the requesting partner. Relevant only for resource sharing requests. |
partnerCode | string | Partner code of the requesting partner. Relevant only for resource sharing requests. |
institutionCode | string | Institution code of the target Pickup Location. Relevant only when the destination is institution. |
libraryCode | string | Library Code of the target Pickup Location. Relevant only when the destination is library. |
digitizationDepartmentCode | string | Digitization department Code of the designated department. Relevant only when request is digitization. |
nzMmsId | string | In case of manual description requests we add the NZ MMS ID, if exists. |
requestNote | string | Note of the request, if exists. |
bibliographicInformation | bibliographicInformation | Bibliographic meta-data regarding the requested item. |
exportPickup
Description: The target Pickup Location.
The remote storage system should send the item to this location for pickup.
| Field | Type | Description |
|---|---|---|
institution | string | Institution description of the target Pickup Location. Relevant only when the destination is institution. |
library | string | Library description of the target Pickup Location. Relevant only when the destination is library. |
desk | string | Circulation desk description of the target Pickup Location. Relevant only when the destination is circulation desk. |
bibliographicInformation
Description: Bibliographic meta-data regarding the requested item.
| Field | Type | Description |
|---|---|---|
author | string | Author of the requested item.. |
issn | string | ISSN of the requested item. |
isbn | string | ISBN of the requested item. |
placeOfPublication | string | Place publication of the requested item. |
dateOfPublication | string | Date publication of the requested item. |
operationalRecordinformation
Description: Additional information regarding the requested item.
| Field | Type | Description |
|---|---|---|
permanent_ | string | The permanent location code of the requested item. |
permanent_ | string | The permanent call number of the requested item. |
call_ | string | The call number type of the requested item. |
requestedInfo
Description: Additional request information.
| Field | Type | Description |
|---|---|---|
description | string | General description of the request. |
partToDigitize | string | Specific part for digitization. Relevant only for digitization request. |
patronInfo
Description: Information regarding the requesting patron.
Note that patron information will be added only for physical digitization requests and only if the "Handle digitization requests locally" flag is on in the remote storage configuration.
In this case the patron information is needed in order to send the email to the patron from the remote storage.
| Field | Type | Description |
|---|---|---|
patronName | string | Full name of the requesting patron. |
patronIdentifier | string | Primary identifier of the requesting patron. |
patronEmail | string | Email of the requesting patron. |
patronAddress | string | Address of the requesting patron. |
userAddress
Description: Address information.
| Field | Type | Description |
|---|---|---|
line1 | string | Line 1 of the address. |
line2 | string | Line 2 of the address. |
line3 | string | Line 3 of the address. |
line4 | string | Line 4 of the address. |
line5 | string | Line 5 of the address. |
city | string | The address' relevant city. |
stateProvince | string | The address' relevant state. |
postalCode | string | The address' relevant postal code. |
country | string | The address' relevant country. Possible codes are listed in the 'Country Codes' code table. |
enumsAndChrons
Description: The Enum and Chron fields of the requested item. Will be added only if the system type configured in the Integration Profile is W.B. Meyer.
| Field | Type | Description |
|---|---|---|
enumerationA | string | |
enumerationB | string | |
enumerationC | string | |
enumerationD | string | |
enumerationE | string | |
enumerationF | string | |
enumerationG | string | |
enumerationH | string | |
ChronologyI | string | |
ChronologyJ | string | |
ChronologyK | string | |
ChronologyL | string | |
ChronologyM | string |
Samples
XML
JSON
__