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 $$MAKEURL^XTHCURL extrinsic function creates a URL from components.

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

NOTE: This API is IPv6 compliant as of Kernel Toolkit patch XT*7.3*138.

NOTE: This API was released with Kernel Toolkit patch XT*7.3*123.

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

  • HTTP-Port 80.
  • HTTPS-Port 443.
path:

(optional) The path to the Web page on the called server.

.query:

(optional) An array of query parameters.

Output

Returns:

Returns

  • Success: Normalized path (see Example).
  • Fail: -1^Host not defined (if missing host parameter).

Example:

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

http://www.map.com/api/staticmap?center=main%2Bst.%2CAnycity%2CCA&sensor=false

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

Reviewed/Updated: June 6, 2018

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.