Skip to main content
ExLibris

Knowledge Assistant

BETA
  • Subscribe by RSS
  • Back
    Voyager

     

    Ex Libris Knowledge Center
    1. Search site
      Go back to previous article
      1. Sign in
        • Sign in
        • Forgot password
    1. Home
    2. Voyager
    3. Knowledge Articles
    4. Find patron's group ID and DB key for OvP calls

    Find patron's group ID and DB key for OvP calls

    1. Last updated
    2. Save as PDF
    3. Share
      1. Share
      2. Tweet
      3. Share
    1. Question
    2. Answer
    3. Additional Information
    • 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

    SELECT PATRON_GROUP_ID
    , 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

    SELECT DB_KEY
    FROM VOYAGER_DATABASES
    WHERE DB_CODE = 'LOCAL'; 

    DB_KEY
    --------------------------------------------------------------------------------
    QA20012DB20020613131313

    Query for cluster_id
    select CIRC_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
    View article in the Exlibris Knowledge Center
    1. Back to top
      • Files in WebAdmin Reports: what are they, and must I keep them?
      • Find the highest (maximum) record ID (BIB, MFHD, etc.) in Voyager database
    • Was this article helpful?

    Recommended articles

    1. Article type
      Topic
      Language
      English
      Product
      Voyager
    2. Tags
      1. contype:kba
      2. Dedicated-Direct
      3. Direct
      4. Interoperability
      5. Local
      6. Prod:Voyager
      7. Total Care
      8. Type:Q&A
    1. © Copyright 2025 Ex Libris Knowledge Center
    2. Powered by CXone Expert ®
    • Term of Use
    • Privacy Policy
    • Contact Us
    2025 Ex Libris. All rights reserved