Swift

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. Swift

func chilkatTest() {
    var success: Bool = 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"
    // }

    let jsonToken = CkoJsonObject()!
    success = jsonToken.loadFile(path: "qa_data/tokens/qb-access-token.json")

    let rest = CkoRest()!

    // 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.
    var bAutoReconnect: Bool = true
    success = rest.connect(hostname: "sandbox-quickbooks.api.intuit.com", port: 443, tls: true, autoReconnect: bAutoReconnect)
    if success != true {
        print("\(rest.lastErrorText!)")
        return
    }

    let sbAuth = CkoStringBuilder()!
    sbAuth.append(value: "Bearer ")
    sbAuth.append(value: jsonToken.string(of: "access_token"))
    rest.authorization = sbAuth.getAsString()

    rest.addHeader(name: "Accept", value: "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.)
    var responseBody: String? = rest.fullRequestNoBody(httpVerb: "GET", uriPath: "/v3/company/123146096291789/employee/999?minorversion=45")
    if rest.lastMethodSuccess != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    let json = CkoJsonObject()!
    json.load(json: 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.intValue != 400 {
        print("Request Header: ")
        print("\(rest.lastRequestHeader!)")
        print("----")
        print("Response StatusCode = \(rest.responseStatusCode.intValue)")
        print("Response StatusLine: \(rest.responseStatusText!)")
        print("Response Header:")
        print("\(rest.responseHeader!)")
        return
    }

    // If we got here, the response status code was 400..
    // Iterate over the errors..
    var numErrors: Int = json.size(ofArray: "Fault.Error").intValue
    var i: Int = 0
    while i < numErrors {

        json.i = i
        print("Message: \(json.string(of: "Fault.Error[i].Message")!)")
        print("Detail: \(json.string(of: "Fault.Error[i].Detail")!)")
        print("code: \(json.string(of: "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"
    // }

}