API_GetDBvar

Overview

Use API_GetDBVar to get values assigned to variables (DBVars) set up in your QuickBase application. DBVars are variables you can create to use in your application. (See the QuickBase online help to learn how to set up DBVars.

API_GetDBVar returns only one DBVar. If you want to retrieve more than one variable, you'll need to invoke this call multiple times.

Once you've set them up, you can assign values to them using API_SetDBVar. (Use the application-level dbid.) You’ll get an error if the DBVar you ask for does not exist.

top

Request parameters

Parameter Value Required?

varname

The name of the variable in the target application.

yes

ticket

A valid authentication ticket.

The authentication ticket is returned via the API_Authenticate call.

yes,

apptoken

Supply a valid application token.

yes, if the application requires application tokens

udata

A string value that you want returned. It will not be handled by QuickBase but it will be returned in the response.

no

top

Response values

Element Name Value

action

The originating request, for example, API_AddField.

errcode

Identifies the error code, if any. (See the Error Codes appendix for a list of possible error codes.)

0 indicates that no error was encountered.

errtext

Text that explains the error code.

"No error" indicates that no error was encountered.

udata

Optional. Contains any udata value supplied in the request.

value

The value of the DBVar.

top

Sample XML Request

POST https://target_domain/db/target_dbid HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_GetDBVar

<qdbapi>
   <udata>mydata</udata>
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
   <varname>usercode</varname>
</qdbapi>

top

URL alternative

https://target_domain/db/target_dbid?a=API_GetDBVar&ticket=auth_ticket
&apptoken=app_token&varname=usercode

where target_domain is the domain against which you are invoking this call, for example, intuit.quickbase.com. Read about this notation.

top

Sample XML Response

<?xml version="1.0" ?>
<qdbapi>
   <action>API_getDBvar</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <value>12</value>
</qdbapi>

top   

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