List of all Groups
The ListGroups function returns an array of all the groups where the user is enrolled as an administrator and/or editor. Using the request as the superuser will return all groups.
GET/Remote/ListGroups
REQUEST PARAMETERS
| Parameter | Type | Description | Required |
|---|---|---|---|
| mluser | string | Username - always in email form. | |
| mltoken -or- mlpass | string | MapLarge generated auth token -or- the password for the mluser account. | |
| account | string | Response value will only contain groups from this account. |
EXAMPLE REQUEST
https://my.maplarge.com/Remote/ListGroups?mluser=user@domain.com&mltoken=token
*Either a token or password can be used in any request where authentication is required.
RETURNS
{ "id": "65150f8d693a4adeaa65019c7e94acd2", "hash": null, "success": true, "isCached": false, "authorized": true, "errors": [], "timestamp": 1420568624, "data": null, "groups": [ { "id": 8372, "name": "Admins", "account": "test", "description": "Administrative Users", "actions": [ "role~admin", "tile_test_view", "admin~getaccounts~A", "admin~creategroup~A", "admin~editgroup~A", "manage_test_deletegroup", "manage_test_addgroup", "manage_test_editgroup", "manage_test_edituser", "manage_test_viewgroups", "manage_test_adduser", "table_test_add", "table_test_edit", "table_test_delete", "table_test_version", "tile_test_gettile" ], "ownerAccountId": 8991 } ] }
ACTION SPECIFIC RESPONSE VALUES
| Parameter | Type | Description |
|---|---|---|
| groups | mixed[] | A list of all groups in account(s). |
| groups[].id | long | ID of the group. |
| groups[].name | string | Name of the group. |
| groups[].account | string | Account of the group. |
| groups[].description | string | Description of the group. |
| groups[].actions[] | string array |
Role: admin, editor, viewer. Permissions of the group. |
| groups[].ownerAccountId | long | ID of the account that owns the group. |