Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Ruby Web API Examples

Primary Categories

AWS Translate
Azure Maps
Azure OAuth2
Azure Storage Accounts
CardConnect
Cloudfare
Facebook
GeoOp
Jira
Magento
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans

PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Walmart
Xero
eBay
effectconnect

 

 

 

(Ruby) QuickBooks - Full Update an Employee

Demonstrates how to update any of the writable fields of an existing employee. The example first reads the JSON data for the employee, makes some changes, and then POST's the updated JSON to update the employee.

Chilkat Ruby Downloads

Ruby Library for Linux and MAC OS X

require 'chilkat'

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

# This example also assumes an OAuth1 access token was previously fetched.
# and saved in a JSON file.  See the Chilkat online examples at example-code.com
# for Quickbooks OAuth1 examples (in the Quickbooks and OAuth1 categories)
# 

# First get our previously obtained access token.
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/quickbooks.json")

oauth1 = Chilkat::CkOAuth1.new()
oauth1.put_ConsumerKey("QUICKBOOKS_CONSUMER_KEY")
oauth1.put_ConsumerSecret("QUICKBOOKS_CONSUMER_SECRET")
oauth1.put_Token(jsonToken.stringOf("oauth_token"))
oauth1.put_TokenSecret(jsonToken.stringOf("oauth_token_secret"))

rest = Chilkat::CkRest.new()

# Connect using TLS.
# A single REST object, once connected, can be used for many Quickbooks REST API calls.
# The auto-reconnect indicates that if the already-established HTTPS connection is closed,
# then it will be automatically re-established as needed.
bAutoReconnect = true
success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

rest.SetAuthOAuth1(oauth1,false)

# The company ID is the realmId
sbPath = Chilkat::CkStringBuilder.new()
sbPath.Append("/v3/company/<companyID>/employee/<employeeID>")
numReplacements = sbPath.Replace("<companyID>",jsonToken.stringOf("realmId"))
# Assume we already know that we want to read the employee whose Id = 60.
numReplacements = sbPath.Replace("<employeeID>","60")

rest.AddHeader("Accept","application/json")
rest.put_AllowHeaderFolding(false)

responseBody = rest.fullRequestNoBody("GET",sbPath.getAsString())
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

# We should expect a 200 response if successful.
if (rest.get_ResponseStatusCode() != 200)
    print "Request Header: " + "\n";
    print rest.lastRequestHeader() + "\n";
    print "----" + "\n";
    print "Response StatusCode = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response StatusLine: " + rest.responseStatusText() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print responseBody + "\n";
    exit
end

# Load the JSON response into a JSON object for parsing/updating
json = Chilkat::CkJsonObject.new()
json.Load(responseBody)

# Show the JSON..
json.put_EmitCompact(false)
print json.emit() + "\n";
print "----" + "\n";

# The JSON passed in the HTTP POST for updating is the inner content of the Employee
# updateJson is a CkJsonObject
updateJson = json.ObjectOf("Employee")

# Add or update the Line1 of the PrimaryAddr.
updateJson.UpdateString("PrimaryAddr.Line1","2W 298 Campton Hills Rd.")

# Examine the JSON we'll be sending in the body of the POST.
print updateJson.emit() + "\n";
print "----" + "\n";

# Now we're going to POST the changes to update the Quickbooks account.
rest.ClearAllHeaders()
rest.AddHeader("Accept","application/json")
rest.AddHeader("Content-Type","application/json")

sbPath.Clear()
sbPath.Append("/v3/company/<companyID>/employee")
numReplacements = sbPath.Replace("<companyID>",jsonToken.stringOf("realmId"))

# The updated JSON is passed as the HTTP request body.
responseBody = rest.fullRequestString("POST",sbPath.getAsString(),updateJson.emit())
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";

    exit
end

# We should expect a 200 response if successful.
if (rest.get_ResponseStatusCode() != 200)
    print "Request Header: " + "\n";
    print rest.lastRequestHeader() + "\n";
    print "----" + "\n";
    print "Response StatusCode = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response StatusLine: " + rest.responseStatusText() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print responseBody + "\n";

    exit
end

# Load the JSON response into a JSON object to emit in indented form..
json.Load(responseBody)
print json.emit() + "\n";

print "Success." + "\n";

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.