Common optional parameters

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:

<?xml version="1.0" encoding="shift_jis" ?>

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 "escaped." Use %3D for = (equals sign), %3F for ? (question mark), and %26 for & (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 interference unless they are properly escaped. Use %3D for equals, %3F for question marks. Ampersands have special significance in XML so they can’t be used in URLs for XSL style sheets. QuickBase understands carets as a replacement for ampersands when delimiting name/value pairs in query strings. Therefore, don’t use ampersands even in escaped form. Use the caret symbol in escaped form instead: %5E. For example:

?act=dbpage&pagename=mypage.xsl

becomes

%3Fact%3Ddbpage%5Epagename%3Dmypage.xsl

msInUTC

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:

  • your billing account is set to use PST

  • you have a table where field 7 is a Date/Time field

If you issue this API call without using the msInUTC parameter:

?a=API_AddRecord&_fid_7=1267642263823

…QuickBase interprets the value for field 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:

?a=API_AddRecord&_fid_7=1267642263823&msInUTC=1

QuickBase interprets the value for field 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:

?a=API_Authenticate&username=PTBarnum&password=TopSecret
&realmhost=myurl.quickbase.com

top   

© 1999-2013 Intuit Inc. All rights reserved. Legal Notices.