getGroup_v2
Retrieves information about a user group. You can view the same information in the Rescue Administration Center by selecting a user group. For information about group permissions, see How to Create a Technician Group and Assign Permissions in the LogMeIn Rescue Administration Center User Guide.
Changes in Version 2 of getGroup
The following has been introduced in the getGroup_v2 method:
- UnattendedAccess and SessionHoldNotAllowed have been added as new node permissions.
- The RPATCONCURRENTLIMIT option is now available for displaying the limit of concurrent RPAT-enabled technicians.
Input Parameters
Element | Description |
---|---|
node | The ID of the user group of which information you want to retrieve. Required. |
authcode | The secret authentication code that is used to authenticate the user without logging in to Rescue. Optional. |
Output
OK NODEID: 337364 NAME: TechGroup DESCRIPTION: TechGroup1 TYPE: TechnicianGroup PERMISSIONS:
RemoteControl, RemoteView, SendFile, SendURL, ViewSystemInformation, RebootClientComputer,
ReceiveFile, SessionRecording, PrivateSessions, FileManagement, UnlimitedScripting,
SessionTransferNotAllowed, WindowsCredentialsRequestNotAllowed,
ClipboardSynchronizationNotAllowed, CallingCardDeployment, ScreenSharingNotAllowed,
CollaborationNotAllowed, DeviceConfiguration, ChatSuppression, ChatSuppressionConsoleSwitch,
EditCustomField, UnattendedAccess, SessionHoldNotAllowed, LOCKEDPERMISSIONS:
CallingCardDeployment, ISENABLED: True STANDARDCONCURRENTLIMIT: 0 MOBILECONCURRENTLIMIT: 0
RPATCONCURRENTLIMIT: 0
NODEID: The Rescue ID of the user group NAME: Name of the user group DESCRIPTION: Description of the user group TYPE: Group type, which can be Technician Group, Administrator Group, Administrator Group Link, or Pseudo Group PERMISSIONS: Group permissions as defined on the Organization tab of the Administration Center LOCKEDPERMISSIONS: Group permissions that only a Master Administrator can change ISENABLED: Defines whether the group is enabled or not STANDARDCONCURRENTLIMIT: The maximum number of concurrent technicians with standard licences MOBILECONCURRENTLIMIT: The maximum number of concurrent technicians with mobile licences RPATCONCURRENTLIMIT: The maximum number of concurrent RPAT-enabled technicians
Return Values
Displayed Return Value | Description |
---|---|
ERROR | An unspecified error occurred, such as timeout. |
OK | Retrieving information about a user group succeeded. |
NOTLOGGEDIN | Retrieving information about a user group failed because the current user is no longer logged in. |
INVALIDPARAM_NODE | The specified ID is not the ID of an existing user group. |
INVALID_SECRETAUTHCODE | The secret authentication code for the user is invalid. |
USER_DELETED_OR_DISABLED | The user is deleted or disabled. |
Sample Code
The following are examples for using the getGroup_v2 method that you can call in your environment.
HTTP GET
https://secure.logmeinrescue.com/API/getGroup_v2.aspx?node=337364&authcode=4ahx...80u0
HTTP POST
<form method="post" action="https://secure.logmeinrescue.com/API/getGroup_v2.aspx">
<input name="node" value="337364">
<input name="authcode" value="4ahx...80u0">
</form>
C# with SOAP
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using apiSamples.WebServiceClients;
namespace apiSamples
{
public partial class SOAP : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
try
{
//Set up proxy
WebServiceClients.API proxy = new WebServiceClients.API();
proxy.CookieContainer = new CookieContainer();
string sEmail = "some@mail.com";
string sPwd = "secretpassword";
int iNode = [ID of node in which information is being retrieved];
string sAuthCode = "4ahx...80u0";
Group_V2 oGroupV2 = new Group_V2();
//Login
WebServiceClients.loginRet loginResult = proxy.login(sEmail, sPwd);
Response.Write(loginResult + "<br />");
WebServiceClients.getGroupRet oGetGroupV2 = proxy.getGroup_v2(iNode, sAuthCode, out oGroupV2);
Response.Write(oGetGroupV2.ToString());
}
catch (Exception ex)
{
lblError.Text = ex.Message;
}
}
}
}