XML over HTTP Web Services
Purpose
Voyager provides a standard set of services structured around the Voyager core services. The services are in an XML over HTTP format and can also be used by applications that want to interact with Voyager with background services. The XML over HTTP services provide search and result set services as well as circulation activities. They are implemented in the Tomcat version of WebVoyage. You can use these services to “roll your own OPAC”, essentially replacing the ExLibris provided VWEBV front-end.
The services are provided through the VXWS service, and all interactions must go through the VXWS port.
Alphabetical List of Services
| Name | Summary |
|---|---|
| AuthenticatePatron | Authenticate a patron |
| BibLogging | Log the use of bibliographic records that have been emailed or saved |
| BibsForHeading | Displays the bib records that are in a heading |
| BinaryMARCRecordService | Retrieve bib MARC records in binary format |
| BookbagService | Get. clear, or add to a patron’s bookbag |
| Cancel | Cancel requests for a patron |
| ChangePINService | Change a patron’s PIN |
| CourseReservePropertiesService | Use the course reserve search to locate items placed on reserve in Dropdown list page format |
| DB Info Service | Displays information about the current Voyager database |
| GetConfiguration | Get system configuration information |
| GetHoldingsService | Retrieve holdings and item information for a given bibliographic record id or itemId |
| GetUBSitesService | Retrieve information about a local or all databases |
| MediaDeliveryLocService | Retrieves a list of available in-room equipment for a given delivery location |
| MediaItemService | Retrieves a booking info, pick up locations, and a list of available in-room equipment for a given item |
| MediaValidateEquipmentService | Validates a proposed media equipment booking |
| MediaValidateItemService | Validates a proposed media item booking |
| MyAccountService | Retrieve information about a patron’s library account |
| Patron Export Service | Export a group of patron records to an XML file that is suitable for re-loading into the database with the patron update job and web service |
| Patron Import Service | Add, update, or (for some data) delete existing patron personal information such as Name, Address, and the like |
| PatronRequest | Return a request definition for a given request code |
| PatronRequests | Return a list of available requests for a given patron |
| PersonalInfoService | Retrieve information about a patron |
| RelatedBibCountService | Retrieve the number of related bibs for a given bibliographic record id and set of profile codes |
| Renew | Renew an item for a patron |
| ReserveBrowseService | Use the course reserve search to locate items placed on reserve in browse format |
| SavedQueriesService | Retrieve, add, update or delete a patron’s saved queries |
| SearchConnectionService | Manages connections to the databases that will be searched by the SearchService |
| SearchPreferencesService | Retrieve, clear, or set a patron’s search preferences |
| SearchPropertiesService | Retrieve the search properties |
| SearchResultsService | Displays the results of the most recent search |
| SearchService | Displays the results of the search |
| SearchStatusService | Stores a snapshot of the status of the current search |
| SendPatronRequest | Submits a patron request |
| SessionCleanupService | Clean up upon the closing of the VWEBV session that includes only the removal of the VacsClient object created and inserted into the VXWS session |
| ShortLoanDatesService | Return a list of available short loan start and end times |
| StopSearchService | Stops the current simul-search operation |
| UBHoldingsLibService | Retrieves a list of available copies, pick up libraries and pick up locations for a given bibliographic record at a given UB holdings library |
| UBPickupLibService | Retrieves a list of available pick up locations for a given pick up library at a given UB holdings library |