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

PHP Extension Web API Examples

Primary Categories

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
Jira
MYOB

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

 

 

 

(PHP Extension) 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 PHP Downloads

PHP Extension for Windows, Linux, MAC OS X,
Alpine Linux, Solaris, OpenBSD, FreeBSD,
and Linux armhf/aarch64

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// 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 CkJsonObject();
$success = $jsonToken->LoadFile('qa_data/tokens/quickbooks.json');

$oauth1 = new CkOAuth1();
$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 = new CkRest();

// 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;
}

$rest->SetAuthOAuth1($oauth1,false);

// The company ID is the realmId
$sbPath = new CkStringBuilder();
$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->put_AllowHeaderFolding(false);

$responseBody = $rest->fullRequestNoBody('GET',$sbPath->getAsString());
if ($rest->get_LastMethodSuccess() != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
$json = new CkJsonObject();
$json->Load($responseBody);
$json->put_EmitCompact(false);
print $json->emit() . "\n";

// A 400 response is what we'd expect if trying to query an inactive employee...
if ($rest->get_ResponseStatusCode() != 400) {
    print 'Request Header: ' . "\n";
    print $rest->lastRequestHeader() . "\n";
    print '----' . "\n";
    print 'Response StatusCode = ' . $rest->get_ResponseStatusCode() . "\n";
    print 'Response StatusLine: ' . $rest->responseStatusText() . "\n";
    print 'Response Header:' . "\n";
    print $rest->responseHeader() . "\n";
    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->put_I($i);
    print 'Message: ' . $json->stringOf('Fault.Error[i].Message') . "\n";
    print 'Detail: ' . $json->stringOf('Fault.Error[i].Detail') . "\n";
    print 'code: ' . $json->stringOf('Fault.Error[i].code') . "\n";
    print '----' . "\n";
    $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.