include request parameters in X-Server reply

Ex Libris Developer Network MetaLib Documentation MetaLib APIs X-Services include request parameters in X-Server reply

General Purpose

This is a general option that can be added to all existing X-Server API requests. When the display_input parameter is added to a request, it indicates whether the request parameters will display in the response message.

Product Version Compatibility

Version 4.3.0 and later

Input Parameters

Optional
1. DISPLAY_INPUT – X(1)

Explanation of the optional parameters:
  • display_input – Can be defined in each HTTP/XML X-Service request to affect this type of request only. This parameter overrides the value specified for the x_server_display_input parameter, which is defined in the $metalib_conf/www_server.conf file. The following values are valid:
    • N – Do not include the X-Service request parameters in the response.
    • Y – Include the X-Service request parameters in the response.

Input XML Format

<?xml version ="1.0"encoding ="UTF-8"?><x_server_request><$(request_name)_request><display_input>Y/N</display_input>\***********Other parameters**********\\*</$(request_name)_request></x_server_request>

Where $(request_name) represents the name of the X-Server request.

Input URL Syntax

MetalibPath:port /X?op=$(request_name)_request&display_input=Y/N&***********Other parameters***********

Where $(request_name) represents the name of the X-Server request.

Example URL Syntax

http://10.1.235.47:8334/X?op=source_locate_request&source_locate_filter=&requester_ip=10.1.235.47&institute=METALIB&user_group=GUEST&locate_command=WIN=(METALIB)&source_full_info_flag=N&session_id=L9UUHVLPA7LUTEQYM7YJX8GLH6FDR2V77GRG6TIQ21UIXQEXH2&display_input=Y

Output XML Format

Explanation of the output values:
  • input_x_server_request – A wrapper element that encloses the parameters that were specified in the request.
  • input_$(parameter) – Where  $(parameter) represents the name of each of the parameters that were specified in the request.

Example:

<?xml version="1.0"encoding="UTF-8"?><x_server_response metalib_version="4.0.3 (0)"><source_locate_response>\***********Other parameters**********\\*</source_locate_response><input_x_server_request><input_op>source_locate_request</input_op><input_session_id>AVNPL1QKGV46FVR8I413HUCI785NSEAXSMLCSKR9KLPQAG3B1I</input_session_id><input_locate_command>WRD=Pubmed</input_locate_command></input_x_server_request></x_server_response>