(Ruby) QuickBooks - Read an Employee

Demonstrates how to fetch the information for a specific Quickbooks employee. The employee information is fetched by Id. The employee Ids can be obtained by querying the employees and parsing the JSON that is returned.

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

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

# The company ID is 123146096291789
# The employee ID is 58
responseBody = rest.fullRequestNoBody("GET","/v3/company/123146096291789/employee/58?minorversion=45")
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.
# A sample JSON response is shown below.
json = Chilkat::CkJsonObject.new()
json.Load(responseBody)

# These will be used for parsing date/time strings..
dtime = Chilkat::CkDateTime.new()
bLocalTime = true

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

# Get some information from the JSON..
print "Name: " + json.stringOf("Employee.DisplayName") + "\n";
print "Id: " + json.stringOf("Employee.Id") + "\n";
print "City: " + json.stringOf("Employee.PrimaryAddr.City") + "\n";
print "PostalCode: " + json.stringOf("Employee.PrimaryAddr.PostalCode") + "\n";

# Load the CreateTime into a CkDateTime...
dtime.SetFromTimestamp(json.stringOf("Employee.MetaData.CreateTime"))
# dt is a CkDtObj
dt = dtime.GetDtObj(bLocalTime)
print dt.get_Month().to_s() + "/" + dt.get_Day().to_s() + "/" + dt.get_Year().to_s() + "  " + dt.get_Hour().to_s() + 
    ":" + dt.get_Minute().to_s() + "\n";

print "Success." + "\n";

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

# ------------------------------------------------------
# The JSON response looks like this:

# {
#   "Employee": {
#     "SSN": "XXX-XX-XXXX",
#     "PrimaryAddr": {
#       "Id": "116",
#       "Line1": "45 N. Elm Street",
#       "City": "Middlefield",
#       "CountrySubDivisionCode": "CA",
#       "PostalCode": "93242"
#     },
#     "BillableTime": false,
#     "domain": "QBO",
#     "sparse": false,
#     "Id": "98",
#     "SyncToken": "0",
#     "MetaData": {
#       "CreateTime": "2015-07-24T09:34:35-07:00",
#       "LastUpdatedTime": "2015-07-24T09:34:35-07:00"
#     },
#     "GivenName": "Bill",
#     "FamilyName": "Miller",
#     "DisplayName": "Bill Miller",
#     "PrintOnCheckName": "Bill Miller",
#     "Active": true,
#     "PrimaryPhone": {
#       "FreeFormNumber": "234-525-1234"
#     }
#   },
#   "time": "2015-07-24T09:35:54.805-07:00"
#