API_GetGroupRole
Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use API_GetGroupRole determine the roleid for a group within an application.
Request parameters
Parameter | Value | Required? |
|---|---|---|
gid | The id of the group to manage. | 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:
|
usertoken | The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quickbase UI. | yes, one of:
|
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_GetGroupRole. |
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. |
| roles | The roles the group has in the app. |
Sample XML Request
POST https://target_domain/db/target_dbid HTTP/1.1
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_GetGroupRole
<qdbapi>
<udata>misc data</udata>
<ticket>auth_ticket</ticket>
<gid>345889.klsd</gid>
</qdbapi>
Sample HTTP Get Request
https://target_domain/db/target_dbid?a=API_GetGroupRole&gid=345889.klsd&
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_GetGroupRole</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<udata>misc data</udata>
<roles>
<role id=”11”><name>Participant</name>
</role></roles>
</qdbapi>
