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

PowerShell 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

 

 

 

(PowerShell) QuickBooks - Read an Employee (with Error Response)

Demonstrates how to fetch the information for a specific Quickbooks employee, but tries to fetch an inactive employee. Shows the error response and how to parse it.

Chilkat .NET Downloads

Chilkat .NET Assemblies

Chilkat for Mono

[Reflection.Assembly]::LoadFile("C:\myAssemblies\ChilkatDotNet47.dll")

# 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 = New-Object Chilkat.JsonObject
$success = $jsonToken.LoadFile("qa_data/tokens/quickbooks.json")

$oauth1 = New-Object Chilkat.OAuth1
$oauth1.ConsumerKey = "QUICKBOOKS_CONSUMER_KEY"
$oauth1.ConsumerSecret = "QUICKBOOKS_CONSUMER_SECRET"
$oauth1.Token = $jsonToken.StringOf("oauth_token")
$oauth1.TokenSecret = $jsonToken.StringOf("oauth_token_secret")

$rest = New-Object Chilkat.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 -ne $true) {
    $($rest.LastErrorText)
    exit
}

$rest.SetAuthOAuth1($oauth1,$false)

# The company ID is the realmId
$sbPath = New-Object Chilkat.StringBuilder
$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 = 98.
# We know this employee was made inactive, and we should get an error response.
$numReplacements = $sbPath.Replace("<employeeID>","98")

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

$responseBody = $rest.FullRequestNoBody("GET",$sbPath.GetAsString())
if ($rest.LastMethodSuccess -ne $true) {
    $($rest.LastErrorText)
    exit
}

# Load the JSON response into a JSON object for parsing.
# A sample JSON response is shown below.
$json = New-Object Chilkat.JsonObject
$json.Load($responseBody)
$json.EmitCompact = $false
$($json.Emit())

# A 400 response is what we'd expect if trying to query an inactive employee...
if ($rest.ResponseStatusCode -ne 400) {
    $("Request Header: ")
    $($rest.LastRequestHeader)
    $("----")
    $("Response StatusCode = " + $rest.ResponseStatusCode)
    $("Response StatusLine: " + $rest.ResponseStatusText)
    $("Response Header:")
    $($rest.ResponseHeader)
    exit
}

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

    $json.I = $i
    $("Message: " + $json.StringOf("Fault.Error[i].Message"))
    $("Detail: " + $json.StringOf("Fault.Error[i].Detail"))
    $("code: " + $json.StringOf("Fault.Error[i].code"))
    $("----")
    $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": "2016-10-25T14:56:37.335-07:00"
# }
# 

 

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