get_holding

General Purpose

This service retrieves holdings (HOL) information for the Union Catalog document number provided by the user.

Interface Type

X-Service

Product Version Compatibility

Version 18 and later

Input Parameters

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

NOTE: Both parameters are mandatory.

Base: The base of the document entered by the user.

Doc_Num: Number of the document for which HOL information is required.

Output XML Format

The XML output includes information regarding HOL in a union catalog expand document.

Example:

To get HOL information for Document Number 000000028 located in the USM90 base, enter the following URL:

http://ram19:8995/X?op=get_holding&base=usm90&doc-number=000000028

If all goes well, for each HOL record in the expand document, the XML will look like the following:

<?xml version="1.0" encoding="UTF-8" ?>
 <get-holding>
  <cdl-holdings>
 <code>UCB</code>
 <campus>UC Berkeley</campus>
 <library>Bancroft</library>
 <call_number>PA6308.E6 G8 1752</call_number>
 <availability />
 <note>AT NRLF: v.1-2 v. 1-2 (1752)</note>
 </cdl-holdings>
<session-id>RTCQ7P3M972TQT5K6TFB9JPQ5Y1488IANC2C24CG2PE7CR4DKN</session-id>
 </get-holding>

Possible Error Codes

1. If the X-Service is activated without a base having been entered, the following error message appears in the XML output:

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

2. If the borrower entered cannot be found in Z303, the following error message appears in the XML output:

< error>Error reading document</error>

3. If a document number has not been given, the following error message appears in the XML output:

< error>Doc Number must be provided</error>