(PureBasic) JSON FindRecord Example

Demonstrates the FindRecord method for searching an array of JSON records. The data used in this example is available at JSON sample data for FindRecord.

Note: This example requires Chilkat v9.5.0.63 or later.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    ; Note: This example requires Chilkat v9.5.0.63 or later.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(json,"qa_data/json/qb_accounts.json")

    ; A sample of the content of qb_accounts.json is shown at the bottom of this example.
    ; The goal is to search the array of Account records to return the 1st match

    ; Find the account with the name "Advertising"
    arrayPath.s = "QueryResponse.Account"
    relativePath.s = "Name"
    value.s = "Advertising"
    caseSensitive.i = 1

    accountRec.i = CkJsonObject::ckFindRecord(json,arrayPath,relativePath,value,caseSensitive)
    If CkJsonObject::ckLastMethodSuccess(json) <> 1
        Debug "Record not found."
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ; The accountRec should contain this:

    ;       {
    ;         "Name": "Advertising",
    ;         "SubAccount": false,
    ;         "FullyQualifiedName": "Advertising",
    ;         "Active": true,
    ;         "Classification": "Expense",
    ;         "AccountType": "Expense",
    ;         "AccountSubType": "AdvertisingPromotional",
    ;         "CurrentBalance": 0,
    ;         "CurrentBalanceWithSubAccounts": 0,
    ;         "CurrencyRef": {
    ;           "value": "USD",
    ;           "name": "United States Dollar"
    ;         },
    ;         "domain": "QBO",
    ;         "sparse": false,
    ;         "Id": "7",
    ;         "SyncToken": "0",
    ;         "MetaData": {
    ;           "CreateTime": "2016-09-09T14:42:07-07:00",
    ;           "LastUpdatedTime": "2016-09-09T14:42:07-07:00"
    ;         }
    ;       }

    Debug "FullyQualifiedName: " + CkJsonObject::ckStringOf(accountRec,"FullyQualifiedName")
    Debug "AccountType: " + CkJsonObject::ckStringOf(accountRec,"AccountType")
    Debug "AccountSubType: " + CkJsonObject::ckStringOf(accountRec,"AccountSubType")
    Debug "----"
    CkJsonObject::ckDispose(accountRec)

    ; ------------------------------------------------------------------
    ; Find the first account where the currency is USD
    relativePath = "CurrencyRef.value"
    value = "USD"
    caseSensitive = 1

    accountRec = CkJsonObject::ckFindRecord(json,arrayPath,relativePath,value,caseSensitive)
    If CkJsonObject::ckLastMethodSuccess(json) <> 1
        Debug "Record not found."
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug "Name: " + CkJsonObject::ckStringOf(accountRec,"Name")
    Debug "CurrencyRef.name: " + CkJsonObject::ckStringOf(accountRec,"CurrencyRef.name")
    Debug "----"
    CkJsonObject::ckDispose(accountRec)

    ; ------------------------------------------------------------------
    ; Find the first account with "receivable" in the name (case insensitive)
    relativePath = "Name"
    value = "*receivable*"
    caseSensitive = 0

    accountRec = CkJsonObject::ckFindRecord(json,arrayPath,relativePath,value,caseSensitive)
    If CkJsonObject::ckLastMethodSuccess(json) <> 1
        Debug "Record not found."
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug "Name: " + CkJsonObject::ckStringOf(accountRec,"Name")
    Debug "----"
    CkJsonObject::ckDispose(accountRec)

    ; -----------------------------------------------------------------
    ; qb_accounts.json contains this data
    ; 
    ; {
    ;   "QueryResponse": {
    ;     "Account": [
    ;       {
    ;         "Name": "Accounts Payable (A/P)",
    ;         "SubAccount": false,
    ;         "Description": "Description added during update.",
    ;         "FullyQualifiedName": "Accounts Payable (A/P)",
    ;         "Active": true,
    ;         "Classification": "Liability",
    ;         "AccountType": "Accounts Payable",
    ;         "AccountSubType": "AccountsPayable",
    ;         "CurrentBalance": -1602.67,
    ;         "CurrentBalanceWithSubAccounts": -1602.67,
    ;         "CurrencyRef": {
    ;           "value": "USD",
    ;           "name": "United States Dollar"
    ;         },
    ;         "domain": "QBO",
    ;         "sparse": false,
    ;         "Id": "33",
    ;         "SyncToken": "1",
    ;         "MetaData": {
    ;           "CreateTime": "2016-09-10T10:12:02-07:00",
    ;           "LastUpdatedTime": "2016-10-24T16:41:39-07:00"
    ;         }
    ;       },
    ;       {
    ;         "Name": "Accounts Receivable (A/R)",
    ;         "SubAccount": false,
    ;         "FullyQualifiedName": "Accounts Receivable (A/R)",
    ;         "Active": true,
    ;         "Classification": "Asset",
    ;         "AccountType": "Accounts Receivable",
    ;         "AccountSubType": "AccountsReceivable",
    ;         "CurrentBalance": 5281.52,
    ;         "CurrentBalanceWithSubAccounts": 5281.52,
    ;         "CurrencyRef": {
    ;           "value": "USD",
    ;           "name": "United States Dollar"
    ;         },
    ;         "domain": "QBO",
    ;         "sparse": false,
    ;         "Id": "84",
    ;         "SyncToken": "0",
    ;         "MetaData": {
    ;           "CreateTime": "2016-09-14T14:49:29-07:00",
    ;           "LastUpdatedTime": "2016-09-17T13:16:17-07:00"
    ;         }
    ;       },
    ;       {
    ;         "Name": "Advertising",
    ;         "SubAccount": false,
    ;         "FullyQualifiedName": "Advertising",
    ;         "Active": true,
    ;         "Classification": "Expense",
    ;         "AccountType": "Expense",
    ;         "AccountSubType": "AdvertisingPromotional",
    ;         "CurrentBalance": 0,
    ;         "CurrentBalanceWithSubAccounts": 0,
    ;         "CurrencyRef": {
    ;           "value": "USD",
    ;           "name": "United States Dollar"
    ;         },
    ;         "domain": "QBO",
    ;         "sparse": false,
    ;         "Id": "7",
    ;         "SyncToken": "0",
    ;         "MetaData": {
    ;           "CreateTime": "2016-09-09T14:42:07-07:00",
    ;           "LastUpdatedTime": "2016-09-09T14:42:07-07:00"
    ;         }
    ;       },
    ;       {
    ;         "Name": "Arizona Dept. of Revenue Payable",
    ;         "SubAccount": false,
    ;         "FullyQualifiedName": "Arizona Dept. of Revenue Payable",
    ;         "Active": true,
    ;         "Classification": "Liability",
    ;         "AccountType": "Other Current Liability",
    ;         "AccountSubType": "GlobalTaxPayable",
    ;         "CurrentBalance": 0,
    ;         "CurrentBalanceWithSubAccounts": 0,
    ;         "CurrencyRef": {
    ;           "value": "USD",
    ;           "name": "United States Dollar"
    ;         },
    ;         "domain": "QBO",
    ;         "sparse": false,
    ;         "Id": "89",
    ;         "SyncToken": "0",
    ;         "MetaData": {
    ;           "CreateTime": "2016-09-16T12:17:04-07:00",
    ;           "LastUpdatedTime": "2016-09-17T13:05:01-07:00"
    ;         }
    ;       },
    ;       {
    ;         "Name": "Automobile",
    ;         "SubAccount": false,
    ;         "FullyQualifiedName": "Automobile",
    ;         "Active": true,
    ;         "Classification": "Expense",
    ;         "AccountType": "Expense",
    ;         "AccountSubType": "Auto",
    ;         "CurrentBalance": 0,
    ;         "CurrentBalanceWithSubAccounts": 0,
    ;         "CurrencyRef": {
    ;           "value": "USD",
    ;           "name": "United States Dollar"
    ;         },
    ;         "domain": "QBO",
    ;         "sparse": false,
    ;         "Id": "55",
    ;         "SyncToken": "0",
    ;         "MetaData": {
    ;           "CreateTime": "2016-09-14T10:15:53-07:00",
    ;           "LastUpdatedTime": "2016-09-14T10:16:05-07:00"
    ;         }
    ;       },
    ; ...
    ; 


    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure