API_AddGroupToRole

Overview

Use API_AddGroupToRole to add a group to a role in an app.

Request parameters

Parameter

Value

Required?

gid

The id of the group to manage.

yes

roleid

The ID of the access role being assigned to the group.

yes

apptoken

A valid application token.

yes, if the application requires application tokens.

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

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_AddGroupToRole.

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.

A response containing "No error" indicates that no error was encountered.

udata

Optional. Contains any udata value supplied in the request.

top

Sample XML Request

POST https://target_domain/db/target_dbid? HTTP/1.1
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_AddGroupToRole

<qdbapi>
   <udata>misc data</udata>
    <apptoken>app_token</apptoken>
   <ticket>auth_ticket</ticket>
   <gid>345889.ksld</gid>
   <roleid>12</roleid>
</qdbapi>

top

Sample HTTP Get Request

https://target_domain/db/target_dbid?a=API_AddGroupToRole&gid=345889.ksld&
roleid=12&ticket=auth_ticket&udata=misc%20data

where target_domain is the domain against which you are invoking this call, for example, intuit.quickbase.com. Read about this notation.

top

Sample response

<?xml version="1.0" ?>
<qdbapi>
   <action>API_AddGroupToRole</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <udata>misc data</udata>
</qdbapi>

 

Go back    |     |  

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