API Docs

External Sys Remote Storage Export Requests

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.

FieldTypeDescription
requestTypestringDescription of the request type in Alma.
For information purpose only.
requestIdstringThe request identifier in Alma.
pickupexportPickupThe target Pickup Location.
The remote storage system should send the item to this location for pickup.
operationalRecordinformationoperationalRecordinformationAdditional information regarding the requested item.
barcodestringThe barcode of the requested item.
mmsIdstringThe mms id of the requested item.
itemIdstringThe requested item's identifier in Alma.
titlestringThe title of the requested item. Will be added only if the system type configured in the Integration Profile is W.B. Meyer.
copyIdstringThe copy ID of the requested item. Will be added only if the system type configured in the Integration Profile is W.B. Meyer.
descriptionstringThe description of the requested item. Will be added only if the system type configured in the Integration Profile is W.B. Meyer.
enumsAndChronsenumsAndChronsThe 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.
requestedInforequestedInfoAdditional request information.
patronInfopatronInfoInformation 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.
shipAddressuserAddressShipping Address of the target pickup location.
Relevant only when the request is not for resource sharing.
shipAddressPartneruserAddressShipping Address of the requesting partner.
Relevant only for resource sharing requests.
partnerCodestringPartner code of the requesting partner.
Relevant only for resource sharing requests.
institutionCodestringInstitution code of the target Pickup Location.
Relevant only when the destination is institution.
libraryCodestringLibrary Code of the target Pickup Location.
Relevant only when the destination is library.

 

exportPickup

Description: The target Pickup Location.
The remote storage system should send the item to this location for pickup.

FieldTypeDescription
institutionstringInstitution description of the target Pickup Location.
Relevant only when the destination is institution.
librarystringLibrary description of the target Pickup Location.
Relevant only when the destination is library.
deskstringCirculation desk description of the target Pickup Location.
Relevant only when the destination is circulation desk.

 

operationalRecordinformation

Description: Additional information regarding the requested item.

FieldTypeDescription
permanent_physical_location_codestringThe permanent location code of the requested item.
permanent_call_numberstringThe permanent call number of the requested item.
call_number_typestringThe call number type of the requested item.

 

requestedInfo

Description: Additional request information.

FieldTypeDescription
descriptionstringGeneral description of the request.
partToDigitizestringSpecific 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.

FieldTypeDescription
patronNamestringFull name of the requesting patron.
patronIdentifierstringPrimary identifier of the requesting patron.
patronEmailstringEmail of the requesting patron.

 

userAddress

Description: Address information.

FieldTypeDescription
line1stringLine 1 of the address.
line2stringLine 2 of the address.
line3stringLine 3 of the address.
line4stringLine 4 of the address.
line5stringLine 5 of the address.
citystringThe address' relevant city.
stateProvincestringThe address' relevant state.
postalCodestringThe address' relevant postal code.
countrystringThe 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.

FieldTypeDescription
enumerationAstring
enumerationBstring
enumerationCstring
enumerationDstring
enumerationEstring
enumerationFstring
enumerationGstring
enumerationHstring
ChronologyIstring
ChronologyJstring
ChronologyKstring
ChronologyLstring
ChronologyMstring

 

Samples

XML
JSON
__