How to Understand the XML Samples

This document has the XML samples in this kind of format:

POST https://<target_domain>/db/<target_dbid>
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION:API_AddField

<qdbapi>
   <label>label</label>
   <type>type</type>
   <mode>mode</mode> <!-- optional unless lookup or formula-->
   <ticket>ticket</ticket>
   <apptoken>app token</apptoken>
   <udata>whatever</udata> <!--optional pass-thru data -->
</qdbapi>

where target_domain is the domain against which you are invoking this call, for example, quickbase.com and target_dbid is the application or table dbid you are invoking the call against.

There are two parts you need to supply when using the XML form of the API call:

POST https://<target_domain>/db/bddnc6pn7
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION:API_AddField

The first three of these lines are standard HTTP headers for the POST request method. The first is the URL for the POST: this is the path to the destination using secure https. The dbid is the last part of the path. For some calls, this will be replaced by /main, and will be called out in the documentation. The last line is a custom header that QuickBase expects containing the API call itself.

The second part is the XML payload of the HTPPS POST request:

<qdbapi>
   <label>label</label>
   <type>type</type>
   <mode>mode</mode> <!-- optional unless lookup or formula-->
   <ticket>2_bdh78chd4_dpsx_b_dnbypa8d372j5rb6vt6kfdx7ty25</ticket>
   <apptoken>app token</apptoken>
   <udata>whatever</udata> <!--optional pass-thru data -->
</qdbapi>

The elements between the <qdbapi> tags are the parameters: these are documented for each API call.