Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
This call is for use by API client implementations that make use of the ticket cookie rather than the <ticket> parameter.
Invoking this call returns a null ticket cookie (with the name TICKET). In some cases, invoking API_SignOut results in applications at the local machine (the API client) being unable to access Quickbase applications until API_Authenticate is called for a new ticket cookie.
This call does not invalidate any tickets, nor log off the caller from any Quickbase applications, nor prevent further access of Quickbase applications. If the caller has saved a valid ticket, that caller can continue to use that ticket even after API_SignOut is called.
Request parameters
| Parameter | Value | Required? |
|---|---|---|
|
udata |
A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response. |
no |
Response values
| Element Name | Value |
|---|---|
|
action |
The originating request, for example, API_SignOut |
|
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. |
Sample XML Request
POST https://target_domain/db/main HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_SignOut
<qdbapi>
</qdbapi>
URL alternative
https://target_domain/db/main?a=API_SignOut
where target_domain is the domain against which you are invoking this call, for example, quickbase.com. Read about this notation.
Sample response
<?xml version="1.0" ?>
<qdbapi>
<action>api_signout</action>
<errcode>0</errcode>
<errtext>No error</errtext>
</qdbapi>