Xbase++ Requires Chilkat v11.0.0+

REST Follow Redirects

See more REST Examples

Demonstrates how to follow a 302/303 redirect response. Xbase++

LOCAL nSuccess
LOCAL oRest
LOCAL nBTls
LOCAL nPort
LOCAL nBAutoReconnect
LOCAL cResponseText
LOCAL nStatusCode
LOCAL cUrlStr
LOCAL oRedirectUrl

nSuccess := 0

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

oRest := CreateObject("Chilkat.Rest")

nBTls := 1
nPort := 443
nBAutoReconnect := 1
nSuccess := oRest:Connect("chilkatsoft.com", nPort, nBTls, nBAutoReconnect)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
ENDIF

//  Send a POST to a URL that will respond with a 302 redirect..
oRest:AddQueryParam("firstName", "John")
oRest:AddQueryParam("lastName", "Doe")
cResponseText := oRest:FullRequestFormUrlEncoded("POST", "/echoPost302.asp")
IF (oRest:LastMethodSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
ENDIF

nStatusCode := oRest:ResponseStatusCode

//  Examine the response status code
IF (nStatusCode < 300)
    ? "Not a redirect."
    ? cResponseText
    oRest:destroy()
    RETURN
ENDIF

IF (nStatusCode > 399)
    ? "Error response: Status code = " + Str(nStatusCode)
    ? cResponseText
    oRest:destroy()
    RETURN
ENDIF

? "Redirect status code = " + Str(nStatusCode)

//  The response header will contain a Location field with the redirect URL, such as this:
//  Location: http://www.chilkatsoft.com/echoPostFinal.asp

//  The response status code determines how the client should behave.
//  Here are some common possibilities:

//  301: Moved Permanently
//  This and all future requests should be directed to the given URI.  (Keep the original HTTP method for the redirect.  In this case, the 
//  original request was a POST, so we POST to the redirect URL.)

//  302: Found (aka Object Moved aka Moved Temporarily)
//  This is the most popular redirect code, but also an example of industrial practice contradicting the standard. HTTP/1.0 specification (RFC 1945 ) required the client
//  to perform a temporary redirect (the original describing phrase was �Moved Temporarily�), but popular browsers implemented it as a 303 See Other. Therefore, HTTP/1.1
//  added status codes 303 and 307 to disambiguate between the two behaviors. However, the majority of Web applications and frameworks still use the 302 status code
//  as if it were the 303.

//  303: See Other
//  The response to the request can be found under another URI using a GET method. When received in response to a PUT, it should be assumed that the server has
//  received the data and the redirect should be issued with a separate GET message.

//  307: Temporary Redirect
//  In this occasion, the request should be repeated with another URI, but future requests can still use the original URI. In contrast to 303, the request method
//  should not be changed when reissuing the original request. For instance, a POST request must be repeated using another POST request.

? oRest:ResponseHeader

//  Get the redirect URL
cUrlStr := oRest:LastRedirectUrl
IF (oRest:LastMethodSuccess == 0)
    ? "No Location header found for redirect."
    oRest:destroy()
    RETURN
ENDIF

oRedirectUrl := CreateObject("Chilkat.Url")
oRedirectUrl:ParseUrl(cUrlStr)

//  Prep for the redirect..
oRest:ClearAllParts()

//  Disconnect and re-connect.  
//  (This can be skipped if both the host and SSL/TLS conditions are the same.)
oRest:Disconnect(100)
nSuccess := oRest:Connect(oRedirectUrl:Host, oRedirectUrl:Port, oRedirectUrl:Ssl, nBAutoReconnect)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    oRedirectUrl:destroy()
    RETURN
ENDIF

IF ((nStatusCode == 301) .OR. (nStatusCode == 307))
    //  Redirect using a POST, sending the same params to the new destination
    oRest:AddQueryParam("firstName", "John")
    oRest:AddQueryParam("lastName", "Doe")
    cResponseText := oRest:FullRequestFormUrlEncoded("POST", oRedirectUrl:Path)
    IF (oRest:LastMethodSuccess == 0)
        ? oRest:LastErrorText
        oRest:destroy()
        oRedirectUrl:destroy()
        RETURN
    ENDIF

ENDIF

IF ((nStatusCode == 302) .OR. (nStatusCode == 303))
    //  Redirect using a GET, sending the query params found in the redirect URL.
    cResponseText := oRest:FullRequestFormUrlEncoded("GET", oRedirectUrl:PathWithQueryParams)
    IF (oRest:LastMethodSuccess == 0)
        ? oRest:LastErrorText
        oRest:destroy()
        oRedirectUrl:destroy()
        RETURN
    ENDIF

ENDIF

//  Show the final status code and the response text.
? "Final status code = " + Str(oRest:ResponseStatusCode)

? "Final response text (HTML, XML, JSON, or whatever..)"
? cResponseText

oRest:destroy()
oRedirectUrl:destroy()