Initializing help system before first use

httpget

httpget

Purpose
Perform an HTTP GET request.
Synopsis
function httpget(url:string|text, result:string):integer
function httpget(url:string|text, result:string, xhdr:string|text):integer
Arguments
url 
URL to process
result 
File to store the result of the request
xhdr 
Additional headers to add to the request
Return value
HTTP status of the request ( e.g. 200 for success, see HTTP standard specifications for a full list; value 999 indicates that an I/O error occurred during the operation) or the request number (≥1000) if asynchronous mode is active
Example
Retrieve the default entry page of the FICO website in French and store it in the file "fico.html": 
status:=httpget('http://www.fico.com/fr/Pages/default.aspx', 'fico.html')
Further information
1. The function returns after the request has been processed when synchronous mode is active (see http_async). Otherwise, using asynchronous mode, the function returns immediately after having sent the request and the model is notified about the completion of the operation by an event of class EVENT_HTTPEND. In this mode the result file result must be a physical file (although drivers "tmp:" and "null:" can still be used).
2. When building a query it is important to encode data to be sent using urlencode
3. By default the header "Accept-Encoding: gzip" is inserted into the request and the result data is automatically decompressed if the server supports compression. This behaviour is disabled if this optional header is already specified ( e.g. the parameter xhdr includes "Accept-Encoding: identity").
Related topics
httppost, httpput, httpdel, httphead, urlencode, httpcancel.
Module
mmhttp

Parent Topic Procedures and functions

© 2001-2019 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.