URL - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Connectivity : Web Features : Web Page Access : URL package : URL/Get

URL

  

Get

  

fetch data specified by a URL

 

Calling Sequence

Parameters

Options

Description

Examples

References

Compatibility

Calling Sequence

Get( url, options )

Parameters

url

-

a string specifying the URL from which to request data

options

-

options as specified below

Options

• 

cafile=string

  

A certificate file to use when authenticating the server. Maple includes a certificate file containing certificates for the major Certificate Authorities.

• 

mode=one of text, binary, or auto

  

Specifies whether the reply data should be treated as a string (mode=text) or as an Array with data type integer[1] (mode=binary). When mode=auto, the data type is determined by relying on the data type provided by the server. The default is auto. This is only supported by the http and https schemes. ftp transfers are always treated as binary.

• 

output=list or one of content, headers, or code

  

A list of one or more of content, headers, and code, or one of the symbols content, headers, or code. This determines what will be returned by Get. The output will be an expression sequence with the corresponding values. The default is content. This option is only valid with http and https schemes.

• 

password=string

  

The password for authentication. This supersedes any password included in url directly.

• 

proxy=string

  

A URL for a proxy server. This should include the protocol, host, and port number (if not default), For example, to connect to an HTTP proxy myproxy on port 3421, use proxy=http://myproxy:3421.

• 

proxypassword=string

  

Password to use for authentication against the proxy specified by the proxy option.

• 

proxyuser=string

  

Username to use for authentication against the proxy specified by the proxy option.

• 

redirections=integer

  

For HTTP transfers, the number of times Maple should follow a redirect response (HTTP status 3xx) before giving up. The default is 0, meaning redirects are not followed.

• 

requestheaders=list(string) or table

  

A list of strings and equations of strings that will be added to the http header that is sent as part of the request.

• 

responseheaders=list(string)

  

A list of strings specifying header fields to be returned. This only has an effect if headers is specified in the output option. If this option is not given, all received headers will be returned.

• 

timeout=posint

  

The number of seconds to wait before aborting the transfer. The default is infinity (in other words, no timeout).

• 

user=string

  

The user name for authentication. This supersedes any user name included in url directly.

• 

verify=truefalse

  

Specifies whether Maple should authenticate the identity of the server by verifying its SSL certificate against a list of verified Certificate Authorities. The default is true. This option is only valid when using https.

Description

• 

The Get method fetches and returns data from the address specified in url.

• 

Get supports three URL schemes: http, https and ftp. Not all options to Get are valid for all URL schemes.

  

For http and https, Get issues a request to url using the HTTP GET method.

• 

For http and https, a Content-Type (as specified in the http header) of text will be returned as a string. All other content types are returned as an Array of integer[1]. This can be overridden using the mode option. For ftp, all transfers are binary, and the result will be returned as an Array of integer[1].

  

The data will be returned as a string or Array with data type integer[1] (this is controlled by the scheme and the mode option).

• 

The output option is a list of one or more of content, headers, and code.

  

content is the content returned by the URL. You can also specify content=string where the string is a filename to which the data will be written.

  

headers refers to the http (and https) header received from the server. It is not supported for URLs with the ftp scheme. It is returned as a table of strings.

  

code refers to the http (and https) status code returned by the server. It is not supported for URLs with the ftp scheme. It is returned as an integer.

Examples

URL:-Gethttp://www.maplesoft.com:

URL:-Gethttps://www.maplesoft.com,timeout=100:

URL:-Getftp://ftp.cert.org/pub/README:

Connect to maplesoft.com using proxy server http://myproxy on port 3421 with specified proxy user credentials.

URL:-Gethttp://www.maplesoft.com,proxy=http://myproxy:3421,proxyuser=graymond,proxypassword=apple

References

  

RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1, W3C.

Compatibility

• 

The URL[Get] command was introduced in Maple 18.

• 

For more information on Maple 18 changes, see Updates in Maple 18.

See Also

StringTools,Encode

URL

URL,Construct

URL,Encode

URL,Post