Ruby

Send a REST Request with a Text Body

Demonstrates Rest.FullRequestString, a convenience method that sends a complete request whose text body (such as JSON, XML, or plain text) is supplied directly, then reads and returns the response body as text.

Background. The full-request convenience methods perform the entire request/response exchange in a single call. FullRequestString is well suited to typical JSON or XML API calls where the body fits comfortably in a string.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

rest = Chilkat::CkRest.new()
bTls = true
bAutoReconnect = true
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
if (success == false)
    print rest.lastErrorText() + "\n";
    exit
end

#  Send a complete request whose text body is supplied directly, such as JSON.  The response body is
#  read as text and returned.  The 1st argument is the HTTP verb, the 2nd is the URI path, and the
#  3rd is the request body.
rest.AddHeader("Content-Type","application/json")

jsonBody = "{ \"name\": \"example\", \"active\": true }"
responseText = rest.fullRequestString("POST","/api/items",jsonBody)
if (rest.get_LastMethodSuccess() == false)
    print rest.lastErrorText() + "\n";
    exit
end

print responseText + "\n";