LogMeIn Rescue API User Guide

getGroup

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.

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, LOCKEDPERMISSIONS: CallingCardDeployment, ISENABLED: True 
STANDARDCONCURRENTLIMIT: 0 MOBILECONCURRENTLIMIT: 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

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 method that you can call in your environment.

HTTP GET

https://secure.logmeinrescue.com/API/getGroup.aspx?node=337364&authcode=4ahx...80u0

HTTP POST

<form method="post" action="https://secure.logmeinrescue.com/API/getGroup.aspx">
        <input name="node" value="337364"> 
        <input name="authcode" value="4ahx...80u0">
</form>

SOAP

For sample SOAP 1.1 and SOAP 1.2 request and response messages, visit https://secure.logmeinrescue.com/api/API.asmx?op=getGroup.

PHP with SOAP

The example values shown must be replaced with actual values.

<?php
	$soapclient = new SoapClient("https://secure.logmeinrescue.com/api/api.asmx?wsdl");

	$loginparams = array (
		'sEmail' => 'some@email.com',
		'sPassword' => 'secretPassword'
	);

	$getgroupparams = array (
		'iNodeID' => 337364,
		'sAuthCode' => '4ahx...80u0'
	);

	$loginResult = $soapclient->login($loginparams);

	print_r($loginResult);

	$getGroupResult = $soapclient->getGroup($getgroupparams);
	
	print_r($getGroupResult);
?>

C# with HttpWebRequest

The example values shown must be replaced with actual values.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Net;
using System.IO;
using getGroup.WebServiceClients;

namespace getGroup
{
    public partial class _Default : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            try
            {
                string sEndpoint = "https://secure.logmeinrescue.com/api/";
                string sEmail = "some@email.com";
                string sPwd = "secretPassword";
                int iNode = 337364;
                string sAuthCode = "4ahx...80u0";

                HttpWebRequest oLogin = (HttpWebRequest)WebRequest.Create(sEndpoint +
 "login.aspx" + "?email=" + sEmail + "&pwd=" + sPwd);
                oLogin.CookieContainer = new CookieContainer();

                HttpWebResponse oLoginResp = (HttpWebResponse)oLogin.GetResponse();
                string sLoginResp = new StreamReader(oLoginResp.GetResponseStream())
.ReadToEnd();
                Response.Write(sLoginResp + "<br />");

                CookieContainer sessioncookie = oLogin.CookieContainer;

                HttpWebRequest oGetGroup = (HttpWebRequest)WebRequest.Create(sEndpoint +
 "getGroup.aspx" + "?node=" + iNode + "&authcode=" + sAuthCode);
                oGetGroup.CookieContainer = sessioncookie;

                HttpWebResponse oGetGroupResp = (HttpWebResponse)oGetGroup.GetResponse();
                string sGetGroupResp = new StreamReader(oGetGroupResp.GetResponseStream())
.ReadToEnd();
                Response.Write(sGetGroupResp);
            }
            catch (Exception ex)
            {
                lblError.Text = ex.Message;
            }
        }
    }
}

C# with SOAP

The example values shown must be replaced with actual values.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Net;
using System.IO;
using createGroup.WebServiceClients;

namespace createGroup
{
    public partial class _Default : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            try
            {
                string sEmail = "some@mail.com";
                string sPwd = "secretpassword";
                int iNode = [ID of node in which information is being retrieved];
                string sAuthCode = "";
                Group oGroup = new Group();

                WebServiceClients.API proxy = new WebServiceClients.API();
                proxy.CookieContainer = new CookieContainer();

                WebServiceClients.loginRet loginResult = proxy.login(sEmail, sPwd);
                Response.Write(loginResult + "<br />");

                WebServiceClients.getGroupRet oGetGroup = proxy.getGroup(iNode, sAuthCode,
 out oGroup);
                Response.Write(oGetGroup.ToString());
            }
            catch (Exception ex)
            {
                lblError.Text = ex.Message;
            }
        }
    }
}