API_DoQueryCount

Overview

You invoke this call against a table dbid using a query string to determine the number of records that will be returned.

top

Request parameters

Parameter Value Required?

query

The query string. See API_DoQuery for information on building the query string.

yes

ticket

A valid authentication ticket.

The authentication ticket is returned via the API_Authenticate call.

yes, one of:

  • ticket
  • username/password
  • user token

usertoken

The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quick Base UI.

yes, one of:

  • ticket
  • username/password
  • user token

apptoken

A valid application token.

yes, if the application requires application tokens

top

Response values

Element Name Value

action

The originating request, for example, API_DoQueryCount.

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.

numMatches

The number of records matching the query string.

top

Sample XML Request

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

<qdbapi>
   <query>{'7'.XCT.'blue car'}</query>
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
</qdbapi>

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

top

Sample response

<?xml version="1.0" ?>
<qdbapi>
   <action>API_DoQueryCount</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <numMatches>1</numMatches>
</qdbapi>

 

Go back    |     |  

© 1999-2018 QuickBase, Inc. All rights reserved. Legal Notices.