item_data

General Purpose

The service retrieves the document number from the user.

For each of the document’s items it retrieves:

  • Item information (From Z30).
  • Loan information (from Z36).
  • An indication whether the request is on-hold.

Interface Type

X-Service

Product Version Compatibility

Version 18 and later

Input Parameters

1. BASE – X (20).
2. SYS_NUMBER – 9 (9).

NOTE: Base is mandatory in this X-service.

  • Base: The logical base to which the retrieved document belongs.
  • Doc_Number/Doc_Num: The number of the document for which the user would like to get items information.

Output XML Format

The output XML includes part of the fields of Z30 and Z36 and indications (Y/N) if an item is on-hold.

Example:

If the user would like to get item data on all items of:

  • Doc Number: 10
  • Under BASE: LAM (There are three items for this document).
http://ram19:8995/X?op=item-data&doc_number=000000010&base=LAM

The following is the XML output:

<?xml version = "1.0" encoding = "UTF-8"?>
<item-data>
  <item>
    <rec-key>000000010000010</rec-key>
    <barcode>32044014006092</barcode>
    <sub-library>Main Library</sub-library>
    <collection>WIDHE</collection>
    <item-status>44</item-status>
    <note></note>
    <call-no-1>$$hBM522.26$$i.E58 x 1981</call-no-1>
    <call-no-2></call-no-2>
    <description>v. 2</description>
    <chronological-i></chronological-i>
    <chronological-j></chronological-j>
    <chronological-k></chronological-k>
    <enumeration-a></enumeration-a>
    <enumeration-b></enumeration-b>
    <enumeration-c></enumeration-c>
    <library>USM50</library>
    <on-hold>N</on-hold>
    <requested>N</requested>
    <expected>N</expected>
  </item>
  <item>
    <rec-key>000000010000020</rec-key>
    <barcode>32044060563244</barcode>
    <sub-library>Law Library</sub-library>
    <collection>ILS</collection>
    <item-status>01</item-status>
    <note></note>
    <call-no-1>$$hBM522.26$$i.E542 1981 SMON</call-no-1>
    <call-no-2></call-no-2>
    <description>v.1</description>
    <chronological-i></chronological-i>
    <chronological-j></chronological-j>
    <chronological-k></chronological-k>
    <enumeration-a></enumeration-a>
    <enumeration-b></enumeration-b>
    <enumeration-c></enumeration-c>
    <library>USM50</library>
    <on-hold>N</on-hold>
    <requested>N</requested>
    <expected>N</expected>
  </item>
  <item>
    <rec-key>000000010000030</rec-key>
    <barcode>32044060563384</barcode>
    <sub-library>Law Library</sub-library>
    <collection>ILS</collection>
    <item-status>01</item-status>
    <note></note>
    <call-no-1>$$hBM522.26$$i.E542 1981 SMON</call-no-1>
    <call-no-2></call-no-2>
    <description>v.2</description>
    <chronological-i></chronological-i>
    <chronological-j></chronological-j>
    <chronological-k></chronological-k>
    <enumeration-a></enumeration-a>
    <enumeration-b></enumeration-b>
    <enumeration-c></enumeration-c>
    <library>USM50</library>
    <on-hold>N</on-hold>
    <requested>N</requested>
    <expected>N</expected>
  </item>
  <session-id>Y4RLQQX5VTQBP5IV3GA7HI1SYITYTJSYM54GBLG2FA9MTKM46D</session-id>
</item-data>

Possible Error Codes

1. If the user tried to activate the X-Service without enterng the doc number:

< error>Doc_Number must be supplied</error>

2. If the user tried to activate the X-Service without entering the base:

< error>Base must be included in service params.</error>

3. If an error occurred while trying to get Z30 items of the document:

< error>Error reading document</error>

4. If no items are associated with the given document:

< error>No associated items</error>