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

ABN AMRO
AWS Translate
Activix CRM
Adyen
Amazon MWS
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Bluzone
CardConnect
ClickBank
Clickatell
Cloudfare
DocuSign
ETrade
Etsy
Facebook
GeoOp
GetHarvest
Global Payments
Google Search Console
Hungary NAV Invoicing
Jira
MYOB
Magento
MercadoLibre

Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Okta OAuth/OIDC
OneLogin OIDC
PayPal
Peoplevox
Populi
QuickBooks
Rabobank
SOAP finkok.com
Shippo
Shopify
Stripe
SugarCRM
Trello
Twilio
Twitter
VoiceBase
Vonage
Walmart
Walmart v3
WhatsApp
WooCommerce
Xero
Yousign
_Miscellaneous_
eBay
effectconnect

 

 

 

(Ruby) QuickBooks - Create an Employee

Demonstrates how to send an JSON request to create a QuickBooks employee

For more information, see https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/employee#create-an-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.

# Get our previously obtained OAuth2 access token, which should contain JSON like this:
# {
#   "expires_in": 3600,
#   "x_refresh_token_expires_in": 8726400,
#   "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
#   "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
#   "token_type": "bearer"
# }

jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

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

sbAuth = Chilkat::CkStringBuilder.new()
sbAuth.Append("Bearer ")
sbAuth.Append(jsonToken.stringOf("access_token"))
rest.put_Authorization(sbAuth.getAsString())

# Create the following JSON:

# Use this online tool to generate code from sample JSON: 
# Generate Code to Create JSON

# {
#   "SSN": "444-55-6666",
#   "PrimaryAddr": {
#     "Id": "50",
#     "Line1": "45 N. Elm Street",
#     "City": "Middlefield",
#     "CountrySubDivisionCode": "CA",
#     "PostalCode": "93242"
#   },
#   "GivenName": "John",
#   "FamilyName": "Meuller",
#   "PrimaryPhone": {
#     "FreeFormNumber": "408-525-1234"
#   }
# }
# 
json = Chilkat::CkJsonObject.new()
json.UpdateString("SSN","444-55-6666")
json.UpdateString("PrimaryAddr.Id","50")
json.UpdateString("PrimaryAddr.Line1","45 N. Elm Street")
json.UpdateString("PrimaryAddr.City","Middlefield")
json.UpdateString("PrimaryAddr.CountrySubDivisionCode","CA")
json.UpdateString("PrimaryAddr.PostalCode","93242")
json.UpdateString("GivenName","John")
json.UpdateString("FamilyName","Meuller")
json.UpdateString("PrimaryPhone.FreeFormNumber","408-525-1234")

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

# The company ID is 123146096291789
responseBody = rest.fullRequestString("POST","/v3/company/123146096291789/employee?minorversion=45",json.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

jsonResponse = Chilkat::CkJsonObject.new()
jsonResponse.Load(responseBody)
jsonResponse.put_EmitCompact(false)
print jsonResponse.emit() + "\n";
print "Success." + "\n";

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

# A sample JSON response:
# {
#   "Employee": {
#     "SSN": "XXX-XX-XXXX",
#     "PrimaryAddr": {
#       "Id": "97",
#       "Line1": "45 N. Elm Street",
#       "City": "Middlefield",
#       "CountrySubDivisionCode": "CA",
#       "PostalCode": "93242"
#     },
#     "BillableTime": false,
#     "domain": "QBO",
#     "sparse": false,
#     "Id": "59",
#     "SyncToken": "0",
#     "MetaData": {
#       "CreateTime": "2016-10-25T14:05:05-07:00",
#       "LastUpdatedTime": "2016-10-25T14:05:05-07:00"
#     },
#     "GivenName": "John",
#     "FamilyName": "Meuller",
#     "DisplayName": "John Meuller",
#     "PrintOnCheckName": "John Meuller",
#     "Active": true,
#     "PrimaryPhone": {
#       "FreeFormNumber": "408-525-1234"
#     }
#   },
#   "time": "2016-10-25T14:05:05.661-07:00"
# }
# 

 

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