API_GrantedGroups

• Overview

• Request parameters

• Response values

• Sample XML Request

• Sample HTTP Get Request

• Sample response

Overview

Use API_GrantedGroups to get the list of groups to which a user has been granted access. If the adminOnly flag is passed, then only return groups in which this user has administration privileges.

Request parameters

Parameter	Value	Required?
userid	The user id.	yes
adminonly	Only return groups where the user has admin rights. Default is FALSE.	no
ticket	A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call.	yes
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_GrantedGroups.
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.
groups	A list of the user’s groups.

top

Sample XML Request

POST https://target_domain/db/main HTTP/1.1
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_GrantedGroups

<qdbapi>
   <udata>misc data</udata>
   <ticket>auth_ticket</ticket>
   <userid>930245.jlpw</userid>
</qdbapi>


top

Sample HTTP Get Request

https://target_domain/db/main?a=API_GrantedGroups&userid=930245.jlpw&
ticket=auth_ticket&udata=misc%20data


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_GrantedGroups</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <udata>misc data</udata>
    <groups>
       <group id=”1217.dgpt”>
          <name>GroupInfoTestGroup</name>
          <description>Demo Test Group</description>
          <managedByUser>false</managedByUser>
       </group>
       <group id=”1218.sfdl”>
          <name>AnotherGroupInfoTestGroup</name>
          <description>Yet Another Demo Test Group</description>
          <managedByUser>true</managedByUser>
       </group>
    </groups>
</qdbapi>