Chilkat2-Python

QuickBooks - Read an Employee (with Error Response)

See more QuickBooks Examples

Demonstrates how to fetch the information for a specific Quickbooks employee, but tries to fetch using an invalid employee id. Shows the error response and how to parse it. Chilkat2-Python

import sys
import chilkat2

success = False

# 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 = chilkat2.JsonObject()
success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

rest = chilkat2.Rest()

# 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)
    sys.exit()

sbAuth = chilkat2.StringBuilder()
sbAuth.Append("Bearer ")
sbAuth.Append(jsonToken.StringOf("access_token"))
rest.Authorization = sbAuth.GetAsString()

rest.AddHeader("Accept","application/json")
rest.AllowHeaderFolding = False

# The company ID is 123146096291789
# The employee ID is 999  (There is no employee with this ID and we should get a 400 response code w/ a response body indicating the error.)
responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/999?minorversion=45")
if (rest.LastMethodSuccess != True):
    print(rest.LastErrorText)
    sys.exit()

# Load the JSON response into a JSON object for parsing.
# A sample JSON response is shown below.
json = chilkat2.JsonObject()
json.Load(responseBody)
json.EmitCompact = False
print(json.Emit())

# A 400 response is what we'd expect if trying to query for a non-existent employee ID
if (rest.ResponseStatusCode != 400):
    print("Request Header: ")
    print(rest.LastRequestHeader)
    print("----")
    print("Response StatusCode = " + str(rest.ResponseStatusCode))
    print("Response StatusLine: " + rest.ResponseStatusText)
    print("Response Header:")
    print(rest.ResponseHeader)
    sys.exit()

# If we got here, the response status code was 400..
# Iterate over the errors..
numErrors = json.SizeOfArray("Fault.Error")
i = 0
while i < numErrors :

    json.I = i
    print("Message: " + json.StringOf("Fault.Error[i].Message"))
    print("Detail: " + json.StringOf("Fault.Error[i].Detail"))
    print("code: " + json.StringOf("Fault.Error[i].code"))
    print("----")
    i = i + 1

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

# {
#   "Fault": {
#     "Error": [
#       {
#         "Message": "Object Not Found",
#         "Detail": "Object Not Found : Something you're trying to use has been made inactive. Check the fields with accounts, customers, items, vendors or employees.",
#         "code": "610",
#         "element": ""
#       }
#     ],
#     "type": "ValidationFault"
#   },
#   "time": "2020-03-07T10:21:19.089-08:00"
# }