API_GetNumRecords

Overview

Use API_GetNumRecords to get the total number of records in the table. Invoke this call on a table-level dbid.

top

Request parameters

Parameter Value Required?

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 application tokens are being used by the application

udata

A string value that you want returned. It will not be handled by Quick Base 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.

num_records

The total number of records in the table.

top

Sample XML Request

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

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

top

URL Alternative

https://target_domain/db/target_dbid?a=API_GetNumRecords
&ticket=auth_ticket&apptoken=app_token

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_GetNumRecords</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <num_records>17</num_records>
</qdbapi>

 

Go back    |     |  

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