Toolkit 7.3 APIs Banner [skip navigation]
Office of Information & Technology (OIT) Banner

$$MAKEURL^XTHCURL(): Creates a URL from Components

Reference Type: Supported, Category: Toolkit—HTTP Client Helper, Integration Agreement: 5554

Description

The Kernel Toolkit Hypertext Transfer Protocol (HTTP) Client Helper software release adds a new tool in a set of Infrastructure software tools that developers can use. HTTP is a fast and reliable way for an application to collect data from another source. Kernel Toolkit Patch XT*7.3*123 allows VistA to tap into this information and retrieve Web data.

This code was developed by another VistA application that had a pressing need for this capability. The Kernel Toolkit development team is providing it as generic tool so that other developers may use its functionality for their needs. For example:

This extrinsic function returns a URL created from input components using the HTTP Client Helper 1.0 software. This API was introduced with Kernel Toolkit Patch XT*7.3*123.

NOTE: XTHC* routines are part of the HTTP Client Helper application for developers.

Format

  $$MAKEURL^XTHCURL(host[,port][,path][,.query])

Input Parameters

host:

(required) The Fully Qualified Domain Name (FQDN) or Internet Protocol (IP) address of the system to which it connects.

port:

(optional) The port to use is if not Port 80.

path:

(optional) The path to the page.

.query:

(optional) An array of query parameters.

Output

Returns:

Returns URL.

Example:

S host="http://maps.google.com"
S path="maps/api/staticmap"
S query("center")="1301+clay+st.,Oakland,CA"
S query("zoom")=14
S query("size")="512x512"
S query("maptype")="roadmap"
S query("sensor")="false"
W $$MAKEURL^XTHCURL(host,,path,.query)

http://maps.google.com/maps/api/staticmap?center=1301%2Bclay%2Bst.%2COakland%2CCA&maptype=roadmap&sensor=false&size=512x512&zoom=14

VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: August 26, 2011

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.