Ready to Learn?Ex Libris products all provide open APIs

item_data_multi

item_data_multi

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 19 and later

 

Input Parameters

1. BASE - X (20).
2. SYS_NUMBER - 9 (9).
3. START_POINT - 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.
  • Start_point: If the document has over 989 items, this is the sequential number of the last item in the previous XML. The next XML output will start from this point + 1.

 

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:

To get item data on all items of:

  • Doc Number: 000015476
  • Under BASE: USM01
  • Start Point: 0000 (starts from the 1st item, there are 1096 items for this document).

enter the following URL:

http://il-aleph20:4203/X?op=item_data_multi&doc_number=000015476&base=USM01&start_point=000000000


The following is the XML output:

 

<?xml version = "1.0" encoding = "UTF-8"?>
<item-data-multi>
    <item>
        <rec-key>000015476000010</rec-key>
        <barcode>32044060180726</barcode>
        <sub-library>East Asian Library</sub-library>
        <collection>W</collection>
        <item-status>01</item-status>
        <note></note>
        <call-no-1>$$hDS801$$i.J294$$mLatest issue: Reading Room</call-no-1>
        <call-no-2></call-no-2>
        <description></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>000015476000020</rec-key>
        <barcode>15476-20</barcode>
        <sub-library>Law Library</sub-library>
        <collection>GEN</collection>
        <item-status>02</item-status>
        <note></note>
        <call-no-1>$$hNN123$$i.R36</call-no-1>
        <call-no-2></call-no-2>
        <description>v.12:no.1(2003:Jan. 01)</description>
        <chronological-i>2003</chronological-i>
        <chronological-j>01</chronological-j>
        <chronological-k>01</chronological-k>
        <enumeration-a>12</enumeration-a>
        <enumeration-b>1</enumeration-b>
        <enumeration-c></enumeration-c>
        <library>USM50</library>
        <on-hold>N</on-hold>
        <requested>N</requested>
        <expected>Y</expected>
    </item>
    <item>
        <!-- ... -->
    </item>
    <item>
        <rec-key>000015476009870</rec-key>
        <barcode>15476-987050</barcode>
        <sub-library>Law Library</sub-library>
        <collection>GEN</collection>
        <item-status>02</item-status>
        <note></note>
        <call-no-1>$$hNN123$$i.R36</call-no-1>
        <call-no-2></call-no-2>
        <description>v.14:no.256(2004:Sept. 12)</description>
        <chronological-i>2004</chronological-i>
        <chronological-j>09</chronological-j>
        <chronological-k>12</chronological-k>
        <enumeration-a>14</enumeration-a>
        <enumeration-b>256</enumeration-b>
        <enumeration-c></enumeration-c>
        <library>USM50</library>
        <on-hold>N</on-hold>
        <requested>N</requested>
        <expected>Y</expected>
    </item>
    <item>
        <rec-key>000015476009880</rec-key>
        <barcode>15476-988050</barcode>
        <sub-library>Law Library</sub-library>
        <collection>GEN</collection>
        <item-status>02</item-status>
        <note></note>
        <call-no-1>$$hNN123$$i.R36</call-no-1>
        <call-no-2></call-no-2>
        <description>v.14:no.257(2004:Sept. 13)</description>
        <chronological-i>2004</chronological-i>
        <chronological-j>09</chronological-j>
        <chronological-k>13</chronological-k>
        <enumeration-a>14</enumeration-a>
        <enumeration-b>257</enumeration-b>
        <enumeration-c></enumeration-c>
        <library>USM50</library>
        <on-hold>N</on-hold>
        <requested>N</requested>
        <expected>Y</expected>
    </item>
    <item>
        <rec-key>000015476009890</rec-key>
        <barcode>15476-989050</barcode>
        <sub-library>Law Library</sub-library>
        <collection>GEN</collection>
        <item-status>02</item-status>
        <note></note>
        <call-no-1>$$hNN123$$i.R36</call-no-1>
        <call-no-2></call-no-2>
        <description>v.14:no.258(2004:Sept. 14)</description>
        <chronological-i>2004</chronological-i>
        <chronological-j>09</chronological-j>
        <chronological-k>14</chronological-k>
        <enumeration-a>14</enumeration-a>
        <enumeration-b>258</enumeration-b>
        <enumeration-c></enumeration-c>
        <library>USM50</library>
        <on-hold>N</on-hold>
        <requested>N</requested>
        <expected>Y</expected>
    </item>
    <item>
        <rec-key>000015476009900</rec-key>
        <barcode>15476-990050</barcode>
        <sub-library>Law Library</sub-library>
        <collection>GEN</collection>
        <item-status>02</item-status>
        <note></note>
        <call-no-1>$$hNN123$$i.R36</call-no-1>
        <call-no-2></call-no-2>
        <description>v.14:no.259(2004:Sept. 15)</description>
        <chronological-i>2004</chronological-i>
        <chronological-j>09</chronological-j>
        <chronological-k>15</chronological-k>
        <enumeration-a>14</enumeration-a>
        <enumeration-b>259</enumeration-b>
        <enumeration-c></enumeration-c>
        <library>USM50</library>
        <on-hold>N</on-hold>
        <requested>N</requested>
        <expected>Y</expected>
    </item>
    <start-point>000000989</start-point>
    <session-id>L6P6PH1VC6CYFASRAN1TAB5RMJTK1XI5JPTFJ9UBNL2A6LU7H9</session-id>
</item-data-multi>


In addition, if the document has over 989 items, the following line will appear at the end:

<start-point>000000989</start-point>
 

Then the next URL will bring the next 989 items, starting from the 990st:

http://il-aleph20:4203/X?op=item_data_multi&doc_number=000015476&base=USM01&start_point=000000989

 etc...

 

Possible Error Codes

1. If the user tried to activate the X-Service without entering 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>

 5. If the given start point exceeds the number of items for the given doc number: 

<error>Start point is greater than the number of items for given doc number.</error>