X-Services

MetaLib provides application services to clients via its APIs. This allows customers to search it from the user interface of their choice without having to compromise on functionality. Thanks to the various X-Services the MetaLib experience can be recreated virtually anywhere.

The X-Server provides compound, comprehensive services, which can be divided into the following categories:

General

SectionSummary
loginEstablishes a connection with the MetaLib X-Server
retrieve_metalib_infoRetrieves MetaLib system parameters and run time status of Metalib programs
include request parameters in X-Server replyIndicates whether the request parameters will display in the response message

User Information

SectionSummary
bor_authRequests authorization information for a specific user
bor_infoRequests user information for a specific user

Resource Retrieval

SectionSummary
source_locateLocates resource(s) by matching criteria
retrieve_categoryRetrieves a list of categories per user profile (Institution / Portal)
retrieve_resources_by_categoryRetrieves a list of resources included in a specific category/subcategory defined by a MetaLib Institution / Portal
retrieve_quick_setsRetrieves a list of QuickSets per user profile (Institution / Portal)
retrieve_resources_by_quick_setsRetrieves a list of resources included in a specific QuickSet defined by a MetaLib Institution / Portal
retrieve_resource_typesThis X-service enables you to retrieve a list of resource types by institution

Resource Retrieval for Registered Users

SectionSummary
retrieve_eshelf_foldersRetrieves a list of eShelf folders defined for a logged-in user
retrieve_eshelf_folder_recordsRetrieves a single or multiple records included in an eShelf folder defined for a logged-in user
retrieve_my_ejournalsRetrieves a list of My e-Journals for a logged-in user
retrieve_my_setsRetrieves a list of ‘My Databases’ defined for a logged-in user
retrieve_resources_by_my_setsRetrieves a list of resources included in a specific ‘My Databases’ set defined for a logged-in user

Search and Retrieval

SectionSummary
findSearches in one or more specified resources
find_group_infoRetrieves a report on the status of the search process for each resource by using the search identifier (= group_number)
merge_sortMerges several result sets from different resources (but only from one group_number) into one result set
presentRetrieves a single record or multiple records (documents) from the results set
retrieve_cluster_facetRetrieves the cluster and facet data of the search results, using the Vivisimo cluster engine
search_quick_setsSearches in a specified QuickSet
save_citationSave retrieved records in format suitable for loading into Citation Manager software

Search and Retrieval for Registered Users

SectionSummary
search_my_setsSearches in a specified ‘My Databases’ set