Getting Information about a Group
The GetGroupInformation function is used to return all information about a single group.
GET/Remote/GetGroupInformation
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. | |
| id | long | The ID of the group. |
EXAMPLE REQUEST
https://my.maplarge.com/Remote/GetGroupInformation?mluser=user@domain.com&mltoken=token&id=8562
*Either a token or password can be used in any request where authentication is required.
RETURNS
{ "id": "c10926aea31148b58f75de55821c6c61", "hash": null, "success": true, "isCached": false, "authorized": true, "errors": [], "timestamp": 1420568624, "data": null, "group": { "id": 8562, "name": "testgroup2553", "account": "test", "description": "testdescription", "perm_level": "admin", "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" ], "users": [ { "name": "test234(test@domain.com)", "id": 8490 } ] } }
ACTION SPECIFIC RESPONSE VALUES
| Parameter | Type | Description |
|---|---|---|
| group | array | Meta data about single group. |
| group.id | long | The ID of the group. |
| group.name | string | The name of the group. |
| group.description | string | The description of the group. |
| group.perm_level | string | The permission level of the group. Values: admin, editor, viewer. |
| group.actions[] | string | Array of allowable actions for the group. |
| group.users[] | string | Array of users enrolled in group. |
| users.name | string | Name of user enrolled in group. |
| users.id | long | ID of user enrolled in group. |