Read the REST Response Body into a Stream

See more REST Examples

Demonstrates Rest.ReadRespBodyStream, which reads the response body into a Stream. The optional flag sets the stream character set from the response Content-Type charset for textual responses.

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.

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoRest
    Boolean iBTls
    Boolean iBAutoReconnect
    Integer iStatusCode
    Variant vSbError
    Handle hoSbError
    Variant vRespStream
    Handle hoRespStream
    Boolean iBAutoSetCharset
    String sTemp1

    Move False To iSuccess

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End
    Move True To iBTls
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "example.com" 443 iBTls iBAutoReconnect To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  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.

    Get ComSendReqNoBody Of hoRest "GET" "/api/images/1" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComReadResponseHeader Of hoRest To iStatusCode
    If (iStatusCode < 0) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  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) Begin
        Get Create (RefClass(cComChilkatStringBuilder)) To hoSbError
        If (Not(IsComObjectCreated(hoSbError))) Begin
            Send CreateComObject of hoSbError
        End
        Get pvComObject of hoSbError to vSbError
        Get ComReadRespSb Of hoRest vSbError To iSuccess
        If (iSuccess = False) Begin
            Get ComLastErrorText Of hoRest To sTemp1
            Showln sTemp1
            Procedure_Return
        End

        Showln "Request failed with status code " iStatusCode
        Get ComGetAsString Of hoSbError To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    //  The status code is 200.  Read the response body into a Stream.  Here the stream's sink is a local
    //  file, which is appropriate for large or binary responses.
    Get Create (RefClass(cComChilkatStream)) To hoRespStream
    If (Not(IsComObjectCreated(hoRespStream))) Begin
        Send CreateComObject of hoRespStream
    End
    Set ComSinkFile Of hoRespStream To "qa_output/image.png"

    //  If the 2nd argument is True and the response is textual, the stream's character set is set from
    //  the response Content-Type charset.  It has no effect for binary responses.
    Move True To iBAutoSetCharset
    Get pvComObject of hoRespStream to vRespStream
    Get ComReadRespBodyStream Of hoRest vRespStream iBAutoSetCharset To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln "Response body written to the stream sink."


End_Procedure