PureBasic

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

IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    success.i = 0

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; We're going to check https://authenticationtest.com/HTTPAuth/
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"authenticationtest.com",port,bTls,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Send a GET request
    responseText.s = CkRest::ckFullRequestNoBody(rest,"GET","/HTTPAuth/")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; 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:
    Debug "Response status code = " + Str(CkRest::ckResponseStatusCode(rest))

    ; The ResponseStatusText property contains the text (if any) that follows the status code on the status line.
    Debug "Response status text = " + CkRest::ckResponseStatusText(rest)

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


    CkRest::ckDispose(rest)


    ProcedureReturn
EndProcedure