DB InfoService

Ex Libris Developer Network Voyager Documentation Voyager APIs XML over HTTP Web Services DB InfoService

General Purpose

The dbInfo web service will show information about the current Voyager database.

Requirements

Voyager 8.2 and higher.

XSD

Click here to view the DB Info Service Schema

Input Parameters

Supported Keys	Supported Key Values
option	location, patrongroup, notetype, statcode, dbinfo, clusters, all

Input URL Syntax

URL Examples:

From Browser:

http://<ipaddress:port>/vxws/dbInfo?option=location
http://<ipaddress:port>/vxws/dbInfo?option=patrongroup
http://<ipaddress:port>/vxws/dbInfo?option=noteType
http://<ipaddress:port>/vxws/dbInfo?option=all
http://<ipaddress:port>/vxws/dbInfo?option=location&option=noteType

From Commmandline:

curl http://<ipaddr>:<vxwsport>/vxws/dbInfo?option=dbinfo | xmllint --format - > dbInfoOutput.xml

Update
Dbinfo service will now return the output preformatted so you don’t have to use xmllint

Output XML Format

Example output from: http://<ipaddress:port>/vxws/dbInfo?option=dbInfo

<?xml version="1.0" encoding="UTF-8"?>
<dbInfoCollection xmlns="http://www.exlibris.com/Voyager/dbinfo">
   <info>
      <reply>
         <reply-text>Success</reply-text>
         <reply-code>SUCCESS</reply-code>
      </reply>
   </info>
   <dbInfo>
      <dbKey>QA20082DB28836413431413</dbKey>
      <version>2008.2.0.ALPHA01</version>
      <dbName>DEV820NCDB</dbName>
   </dbInfo>
</dbInfoCollection>

Possible Error Codes

Error Codes

INIT_FAILURE
DB_ERROR
NO_INPUT_PARAMS
UNKNOWN_OPTION
BAD_PARAM

Example: INIT_FAILURE
General Error setting up the Database context vxws started and service was called while Database was not available

<?xml version="1.0" encoding="UTF-8"?>
<dbInfoCollection xmlns="http://www.exlibris.com/Voyager/dbinfo">
   <info>
      <reply>
         <reply-text>Error trying to initialize context</reply-text>
         <reply-code>INIT_FAILURE</reply-code>
      </reply>
   </info>
</dbInfoCollection>

Example: DB_ERROR
General Error reading data from the database bad data etc

<?xml version="1.0" encoding="UTF-8"?>
<dbInfoCollection xmlns="http://www.exlibris.com/Voyager/dbinfo">
   <info>
      <reply>
         <reply-text>Error Retrieving info from Database</reply-text>
         <reply-code>DB_ERROR</reply-code>
      </reply>
   </info>
</dbInfoCollection>

Example : NO_INPUT_PARAMS
Input URL:

http://localhost:58003/vxws/dbInfo?

<?xml version="1.0" encoding="UTF-8"?>
<dbInfoCollection xmlns="http://www.exlibris.com/Voyager/dbinfo">
   <info>
      <reply>
         <reply-text>No input params were given</reply-text>
         <reply-code>NO_INPUT_PARAMS</reply-code>
      </reply>
   </info>
</dbInfoCollection>

Example : BAD_PARAM
Input URL:

http://localhost:58003/vxws/dbInfo?sss=yyy

<?xml version="1.0" encoding="UTF-8"?>
<dbInfoCollection xmlns="http://www.exlibris.com/Voyager/dbinfo">
   <info>
      <reply>
         <reply-text>Unknown Parameter: sss</reply-text>
         <reply-code>BAD_PARAM</reply-code>
      </reply>
   </info>
</dbInfoCollection>

Example : UNKNOWN_OPTION
Input URL:

http://localhost:58003/vxws/dbInfo?option=yyy

<?xml version="1.0" encoding="UTF-8"?>
<dbInfoCollection xmlns="http://www.exlibris.com/Voyager/dbinfo">
   <info>
      <reply>
         <reply-text>Unknown option value: yyy</reply-text>
         <reply-code>UNKNOWN_OPTION</reply-code>
      </reply>
   </info>
</dbInfoCollection>