Lua

Send a Staged Form-URL-Encoded REST Request

Demonstrates Rest.SendReqFormUrlEncoded, which sends an application/x-www-form-urlencoded request whose body is built from the query parameters added to the object.

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

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

local rest = chilkat.Rest.new()
local bTls = true
local bAutoReconnect = true
local success = rest:connect("example.com", 443, bTls, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

-- The form body is built from the query parameters added to the object.
rest:add_query_param("username", "alice")
rest:add_query_param("action", "login")

-- Send the application/x-www-form-urlencoded request.
success = rest:send_req_form_url_encoded("POST", "/api/login")
if not success then
    print(rest.last_error_text)
    return
end

-- After sending, read the response status line and header fields.  The return value is the HTTP
-- status code, or -1 if no response was received.
local statusCode = rest:read_response_header()
if statusCode < 0 then
    print(rest.last_error_text)
    return
end

print("Response status code: " .. statusCode)

-- Read the response body as text.
local responseBody = rest:read_resp_body_string()
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

print(responseBody)