Find patron's group ID and DB key for OvP calls
- Article Type: Q&A
- Product: Voyager
- Relevant for Installation Type: Total Care; Dedicated-Direct; Direct; Local
Question
Find a patron's group ID and database key to make an API call?
Answer
1. Connect to Prepackaged Reports or SQL*Plus
2. Query for patron group IDs.
3. Query for DB key
4. Query for cluster ID. For single cluster databases (the majority of Voyager installs), the value for the API call will be 1@{DB_KEY}. However, if database has multiple clusters, will also need cluster ID.
See Additional Information for queries & examples.
Additional Information
Connect to Prepackaged Reports or SQL*Plus (note that the Access tables in Reports.MDB can be used as well).
Query for patron group IDs
, PATRON_GROUP_CODE
FROM PATRON_GROUP;
PATRON_GROUP_ID PATRON_GRO
--------------- ----------
1 FAC
2 ST
3 GRAD
4 UND
5 ILL
6 CC
Query for DB key
FROM VOYAGER_DATABASES
WHERE DB_CODE = 'LOCAL';
DB_KEY
--------------------------------------------------------------------------------
QA20012DB20020613131313
Query for cluster_id
, CIRC_CLUSTER_CODE
from CIRC_CLUSTER;
CIRC_CLUSTER_ID CIRC_CLUST
--------------- ----------
1 CL1
2 CL2
In this example, the db key values for the API call would be:
CL1: 1@QA20012DB20020613131313
CL2: 2@QA20012DB20020613131313
Please note that Voyager Support has a very limited ability to assist with the Voyager APIs. We can help identify the APIs that might be useful to you, and provide basic troubleshooting aid. Voyager-L and Developer Network are useful resources for obtaining additional assistance.
Category: Interoperability
- Article last edited: 3/18/2015