DataFlex

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 DataFlex Downloads

Download Chilkat for DataFlex

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoRest
    Boolean iBTls
    Boolean iBAutoReconnect
    Integer iStatusCode
    Variant vSbError
    Handle hoSbError
    Variant vBdResponse
    Handle hoBdResponse
    Boolean iBSaved
    String sTemp1
    Integer iTemp1

    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 as raw bytes into a BinData.
    Get Create (RefClass(cComChilkatBinData)) To hoBdResponse
    If (Not(IsComObjectCreated(hoBdResponse))) Begin
        Send CreateComObject of hoBdResponse
    End
    Get pvComObject of hoBdResponse to vBdResponse
    Get ComReadRespBd Of hoRest vBdResponse To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComWriteFile Of hoBdResponse "qa_output/image.png" To iBSaved
    If (iBSaved <> True) Begin
        Showln "Failed to save the response body."
        Procedure_Return
    End

    Get ComNumBytes Of hoBdResponse To iTemp1
    Showln "Received " iTemp1 " bytes."


End_Procedure