circ_stat_m

General Purpose

The service retrieves the circulation status for each document number entered by the user (suitable for documents with more than 1000 items).

  • Item information (From Z30).
  • Loan information (from Z36).
  • Loan Status (Tab15), Due Date, Due Hour etc.

This service is similar to circ-status X-service, except for the parameter START_POINT which enables to retrieve information for documents with more than 1000 items.

Interface Type

X-Service

Product Version Compatibility

Version 19 and later

Input Parameters

1. LIBRARY – X (5).
2. SYS_NO – 9 (9).
3. START_POINT – 9 (9).

Library: The library of the document for which the user would like to retrieve the circulation status. The LIBRARY must be the BIB library and not the ADM library.

Sys_No: The document for which the user would like to retrieve circulation 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 Z30 and Z36 and some data regarding the item’s status.

The user would like to retrieve the circulation status regarding the items of document: 000000010:

http://server.name:8995/X?op=circ-stat-m&sys_no=000000010&library=usm01&start_point=000000001

The following is the output XML:

Example:

<?xml version="1.0" encoding="UTF-8"?>
<circ-status>
        <item-data>
                <z30-description>v.1</z30-description>
                <loan-status>Regular loan</loan-status>
                <due-date>On Shelf</due-date>
                <due-hour/>
                <sub-library>Law Library</sub-library>
                <collection>ILS</collection>
                <location>BM522.26 .E542 1981 SMON</location>
                <pages/>
                <no-requests/>
                <location-2/>
                <barcode>32044060563244</barcode>
                <opac-note/>
        </item-data>
        <item-data>
                <z30-description>v.2</z30-description>
                <loan-status>Regular loan</loan-status>
                <due-date>On Shelf</due-date>
                <due-hour/>
                <sub-library>Law L</sub-library>
                <collection>ILS</collection>
                <location>BM522.26 .E542 1981 SMON</location>
                <pages/>
                <no-requests/>
                <location-2/>
                <barcode>32044060563384</barcode>
                <opac-note/>
        </item-data>
        <item-data>
                <z30-description>v. 2</z30-description>
                <loan-status>Regular loan</loan-status>
                <due-date>On Shelf</due-date>
                <due-hour/>
                <sub-library>Main</sub-library>
                <collection>WID-LC Hebrew</collection>
                <location>BM522.26 .E58 x 1981</location>
                <pages/>
                <no-requests/>
                <location-2/>
                <barcode>32044014006092</barcode>
                <opac-note/>
        </item-data>
        <session-id>7VFLL5GG4A1KAPKHPG2LPJDLJH2835VS4KY3BBH87L3Q6TTHDY</session-id>
</circ-status>

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://server.name:8995/X?op=circ-stat-m&sys_no=000000010&library=usm01&start_point=000000989

etc…

Possible Error Codes

1. If the user tried to activate the X-Service without giving Doc Number (sys_no)

< error>sys_no must be supplied</error>

2. If the start point parameter is used with a value greater than the number of items

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