AutoIt

Read the REST Response Body into BinData

Demonstrates Rest.ReadRespBd, which reads the response body as raw bytes into a BinData, replacing its previous contents.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat AutoIt Downloads

Download Chilkat for AutoIt

AutoIt

Local $bSuccess = False

$oRest = ObjCreate("Chilkat.Rest")
Local $bTls = True
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("example.com",443,$bTls,$bAutoReconnect)
If ($bSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

;  The file paths are relative to the application's current working directory.  Absolute paths
;  may also be used.  Supply the paths appropriate to your own environment.

$bSuccess = $oRest.SendReqNoBody("GET","/api/images/1")
If ($bSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

Local $iStatusCode = $oRest.ReadResponseHeader()
If ($iStatusCode < 0) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

;  Check for the expected success status code.  If the response is not 200, the body is likely
;  error text formatted as JSON, XML, or HTML rather than the expected binary content.  In that case
;  read the body as text, report it, and return.
If ($iStatusCode <> 200) Then
    $oSbError = ObjCreate("Chilkat.StringBuilder")
    $bSuccess = $oRest.ReadRespSb($oSbError)
    If ($bSuccess = False) Then
        ConsoleWrite($oRest.LastErrorText & @CRLF)
        Exit
    EndIf

    ConsoleWrite("Request failed with status code " & $iStatusCode & @CRLF)
    ConsoleWrite($oSbError.GetAsString() & @CRLF)
    Exit
EndIf

;  The status code is 200.  Read the response body as raw bytes into a BinData.
$oBdResponse = ObjCreate("Chilkat.BinData")
$bSuccess = $oRest.ReadRespBd($oBdResponse)
If ($bSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

Local $bSaved = $oBdResponse.WriteFile("qa_output/image.png")
If ($bSaved <> True) Then
    ConsoleWrite("Failed to save the response body." & @CRLF)
    Exit
EndIf

ConsoleWrite("Received " & $oBdResponse.NumBytes & " bytes." & @CRLF)