API_AddUserToGroup
Overview
Use API_AddUserToGroup to add a user to a group. The user can be added as a member of the group, as a member and a manager of the group, or as a manager but not a member of the group.
Request parameters
|
Parameter |
Value |
Required? |
|---|---|---|
|
gid |
The id of the group to manage. |
yes |
|
uid |
The id of the Quick Base user to add to the group. |
yes |
|
|
The email of the Quick Base user |
no |
|
screenName |
The screen name of the Quick Base user, if set |
no |
|
allowAdminAccess |
Whether the user should be added as an admin of the group. 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 |
Response values
|
Element Name |
Value |
|---|---|
|
action |
The originating request, for example, API_AddUserToGroup. |
|
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.1
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_AddUserToGroup
<qdbapi>
<udata>misc data</udata>
<ticket>auth_ticket</ticket>
<gid>345889.sdfd</gid>
<uid>898790.qntp</uid>
<allowAdminAccess>true</member>
</qdbapi>
Sample HTTP Get Request
https://target_domain/db/main?a=API_AddUserToGroup&gid=345889.sdfd&uid=898790.qntp&
allowAdminAccess=true&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.
Sample response
<?xml version="1.0" ?>
<qdbapi>
<action>API_AddUserToGroup</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<udata>misc data</udata>
</qdbapi>
Did this help you? Give us a rating:
© 1999-2019 QuickBase, Inc. All rights reserved. Legal Notices.