quickbase-json-api-client 0.0.4

Python wrapper for quickbase JSON API.

quickbase-json-api-client

Unofficial Quickbase JSON API wrapper for python

Makes life a little easier!

Quickstart

Installation

To install, run pip install quickbase-json-api-client

Initialize Client

Use the following code to create and initialize a client object.

from quickbase_json.client import QuickbaseJSONClient # import client

client = QuickbaseJSONClient(realm="yourRealm", auth="userToken")

Where yourRealm is the name (subdomain) of your Quickbase Realm and userToken is the user token used to authenticate with the realm.

Query Records

Querying for records is one of the most useful features of the Quickbase JSON API. Querying records with QJAC can be done using the following code

response = client.query_records('tableId', fids, 'queryString')

Where tableId is the ID of the table you wish to query from, fids is a list of field IDs you wish to receive and queryString is a quickbase query string.

Response Objects

A QBResponse object is returned when querying records with QJAC. A QBResponse has several methods that make handling returned data easier. Here are a few of the most useful ones:

denest()

Denests the data. I.e. changes {'fid': {'value': 'actualValue'}} to {'fid': 'actualValue'}

orient(orient='records', key='3')

Orients the data. Currently, the only option is 'records'. This will orient the returned data into a "record like structure", i.e. changes {'fid': 'actualValue', 'fid': 'actualValue'} to {'key': {etc: etc}}