Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
The documentation for each API call lists the parameters you can use with each call. Some parameters can be used with many calls. These are listed in the table below.
| Parameter | Value | Description |
|---|---|---|
|
encoding |
A string that specifies the encoding parameter of the XML output |
The Quickbase API outputs XML using the Unicode character set. If you are using Shift-JIS as your character encoding for a particular Quickbase table, you should specify the encoding parameter on every call you make to ensure that the character encoding of the XML response is properly set. For example:
|
|
rdr |
A redirect URL that should be used when there is no error
|
Allows you to specify a redirect URL. Note that the URL you specify here is not used when Quickbase encounters an error. In error situations, Quickbase always redirects to a standard error page, regardless of what you specify here. If you don't specify a value here, Quickbase does not perform the redirect. Redirect URLs often include query strings with special characters that need to be properly encoded. Use %3D for the equals sign (=), and %3F for the question mark (?), and %26 for the ampersand (&). |
|
xsl |
A URL that points to an XSL document that is referenced in the XML output from the call |
Usually is omitted, in which case the XML return page does not include any reference to an XSL document. XSL URLs often have query strings in them that cause errors unless they are properly encoded. Ampersands have special significance in XML so they can’t be used in URLs for XSL stylesheets. Quickbase understands carets (^) as a replacement for ampersands when delimiting name/value pairs in query strings. Encode the caret as %5E in API calls. For example:
becomes
|
|
1—True. Date/time values are specified in milliseconds as UTC 0 — False. Date/time values are specified in milliseconds using the local application time |
Allows you to specify that Quickbase should interpret all date/time stamps passed in as milliseconds using Coordinated Universal Time (UTC) rather than using the local application time. To understand how to use UTC, consider this example. In this example:
If you issue this API call without using the msInUTC parameter:
…Quickbase interprets the value for field ID 7 as milliseconds in PST. If you then display the record you added, Quickbase displays this value: 03-03-2010 06:51 PM . (The display is always in application local time). If instead you include the msInUTC parameter and issue this API call:
...Quickbase interprets the value for field ID 7 as milliseconds in UTC. If you then display the record you added, Quickbase displays this value:03-03-2010 10:51 AM |
|
|
realmhost |
A domain used to access Quickbase |
If you use a domain other than www.quickbase.com to access Quickbase, you can use this parameter to specify it in your API calls. For example:
where target_domain is the domain against which you are invoking this call, for example, quickbase.com. |
|
X_QUICKBASE_RETURN_HTTP_ERROR |
A header that causes Quickbase to return a 400 (Bad Request) status when there is an API error. |
By default, errors return an HTTP status of 200. However, if the API call passes the header The detailed error code and message are included in the response body. |