DataFlex

Examine HTTP Response Status Code and Text

See more REST Examples

Demonstrates how to examine the HTTP response status code and text when using the REST object. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoRest
    Boolean iBTls
    Integer iPort
    Boolean iBAutoReconnect
    String sResponseText
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

    // We're going to check https://authenticationtest.com/HTTPAuth/
    Move True To iBTls
    Move 443 To iPort
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "authenticationtest.com" iPort iBTls iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Send a GET request
    Get ComFullRequestNoBody Of hoRest "GET" "/HTTPAuth/" To sResponseText
    Get ComLastMethodSuccess Of hoRest To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // The start line of an HTTP response, called the status line, contains the following information:
    // 
    //     The protocol version, usually HTTP/1.1.
    //     A status code, indicating success or failure of the request. Common status codes are 200, 404, or 302
    //     A status text. A brief, purely informational, textual description of the status code to help a human understand the HTTP message.
    // 
    // A typical status line looks like: HTTP/1.1 404 Not Found.

    // The ResponseStatusCode property contains the integer response code:
    Get ComResponseStatusCode Of hoRest To iTemp1
    Showln "Response status code = " iTemp1

    // The ResponseStatusText property contains the text (if any) that follows the status code on the status line.
    Get ComResponseStatusText Of hoRest To sTemp1
    Showln "Response status text = " sTemp1

    // In this case, the sample output is:
    // 
    // Response status code = 401
    // Response status text = Unauthorized


End_Procedure