Visual FoxPro

HTTP POST and Stream Response to File

See more REST Examples

Demonstrates how to send an HTTP POST and stream the response body directly to a file. Visual FoxPro

LOCAL lnSuccess
LOCAL loRest
LOCAL loUrl
LOCAL lnBAutoReconnect
LOCAL lnResponseStatusCode
LOCAL loBodyStream
LOCAL lcErrResponse

lnSuccess = 0

* This example requires the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

loRest = CreateObject('Chilkat.Rest')

loUrl = CreateObject('Chilkat.Url')
* This URL will emit a response that echos the query params (name and age)
loUrl.ParseUrl("https://www.chilkatsoft.com/readPost.asp")

* Connect to the web server
lnBAutoReconnect = 1
lnSuccess = loRest.Connect(loUrl.Host,loUrl.Port,loUrl.Ssl,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loUrl
    CANCEL
ENDIF

loRest.AddQueryParam("name","John")
loRest.AddQueryParam("age","33")

*  Send the HTTP POST.
lnSuccess = loRest.SendReqFormUrlEncoded("POST",loUrl.Path)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loUrl
    CANCEL
ENDIF

* Read the response header.
lnResponseStatusCode = loRest.ReadResponseHeader()
IF (lnResponseStatusCode < 0) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loUrl
    CANCEL
ENDIF

? "Response status code = " + STR(lnResponseStatusCode)

* We expect a 200 response status if the file data is coming.
* Otherwise, we'll get a string response body with an error message(or no response body).
IF (lnResponseStatusCode = 200) THEN

    loBodyStream = CreateObject('Chilkat.Stream')

    * The stream's sink will be a file.
    loBodyStream.SinkFile = "qa_output/out.txt"

    * Read the response body to the stream.  Given that we've
    * set the stream's sink to a file, it will stream directly
    * to the file.
    lnSuccess = loRest.ReadRespBodyStream(loBodyStream,1)
    IF (lnSuccess <> 1) THEN
        ? loRest.LastErrorText
        RELEASE loRest
        RELEASE loUrl
        RELEASE loBodyStream
        CANCEL
    ENDIF

    ? "Successfully streamed the response to a file."

ELSE
    lcErrResponse = loRest.ReadRespBodyString()
    IF (loRest.LastMethodSuccess <> 1) THEN
        ? loRest.LastErrorText
    ELSE
        ? lcErrResponse
    ENDIF

ENDIF

RELEASE loRest
RELEASE loUrl
RELEASE loBodyStream