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
| Section | Summary |
|---|---|
| login | Establishes a connection with the MetaLib X-Server |
| retrieve_metalib_info | Retrieves MetaLib system parameters and run time status of Metalib programs |
| include request parameters in X-Server reply | Indicates whether the request parameters will display in the response message |
| Section | Summary |
|---|---|
| bor_auth | Requests authorization information for a specific user |
| bor_info | Requests user information for a specific user |
| Section | Summary |
|---|---|
| source_locate | Locates resource(s) by matching criteria |
| retrieve_category | Retrieves a list of categories per user profile (Institution / Portal) |
| retrieve_resources_by_category | Retrieves a list of resources included in a specific category/subcategory defined by a MetaLib Institution / Portal |
| retrieve_quick_sets | Retrieves a list of QuickSets per user profile (Institution / Portal) |
| retrieve_resources_by_quick_sets | Retrieves a list of resources included in a specific QuickSet defined by a MetaLib Institution / Portal |
| retrieve_resource_types | This X-service enables you to retrieve a list of resource types by institution |
| Section | Summary |
|---|---|
| retrieve_eshelf_folders | Retrieves a list of eShelf folders defined for a logged-in user |
| retrieve_eshelf_folder_records | Retrieves a single or multiple records included in an eShelf folder defined for a logged-in user |
| retrieve_my_ejournals | Retrieves a list of My e-Journals for a logged-in user |
| retrieve_my_sets | Retrieves a list of ‘My Databases’ defined for a logged-in user |
| retrieve_resources_by_my_sets | Retrieves a list of resources included in a specific ‘My Databases’ set defined for a logged-in user |
| Section | Summary |
|---|---|
| find | Searches in one or more specified resources |
| find_group_info | Retrieves a report on the status of the search process for each resource by using the search identifier (= group_number) |
| merge_sort | Merges several result sets from different resources (but only from one group_number) into one result set |
| present | Retrieves a single record or multiple records (documents) from the results set |
| retrieve_cluster_facet | Retrieves the cluster and facet data of the search results, using the Vivisimo cluster engine |
| search_quick_sets | Searches in a specified QuickSet |
| save_citation | Save retrieved records in format suitable for loading into Citation Manager software |
| Section | Summary |
|---|---|
| search_my_sets | Searches in a specified ‘My Databases’ set |