LogMeIn Rescue API User Guide

setReportArea_v6

Sets the type of report to retrieve with the getReport method. You can set the report area in the Reports tab of the Rescue Administration Center. For information on reports, see Generating Reports in the LogMeIn Rescue Administration Center User Guide.

Changes in Version 6 of setReportArea

The following report area has been introduced in the setReportArea_v6 method:
Transferred Sessions - Extended report
Sets to retrieve a report about transferred sessions.

Input Parameters

Element Description
area The report type that you want to retrieve. Required.

The following report areas are available:

  • 0 - Session report
  • 1 - Customer Survey report
  • 2 - Login report
  • 3 - Missed Sessions report
  • 4 - Performance report
  • 5 - Chat Log report
  • 6 - Custom Fields report
  • 7 - Transferred Sessions report
  • 8 - Technician Survey report
  • 9 - Collaboration Chatlog report
  • 10 - Failed Sessions report
  • 12 - External Collaboration Chatlog report
  • 13 - Customer Survey Issuance report
  • 14 - Daily Performance report
  • 15 - Rebooting/Reconnecting report
  • 16 - Transferred Sessions - Extended report
authcode The secret authentication code that is used to authenticate the user without logging in to Rescue. Optional.

Return Values

Displayed Return Value Description
ERROR An unspecified error occurred, such as timeout.
OK Setting the report type succeeded.
NOTLOGGEDIN Setting the report type failed because the current user is no longer logged in.
INVALIDPARAM_REPORTAREA The specified ID is not the ID of an existing report type.
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 setReportArea_v6 method that you can call in your environment.

HTTP GET

https://secure.logmeinrescue.com/API/setReportArea_v6.aspx?area=16
&authcode=4ahx...80u0

HTTP POST

<form method="post" action="https://secure.logmeinrescue.com/API/setReportArea_v6.aspx">
        <input name="area" value="16">
        <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=setReportArea_v6.

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");

//define parameters
$loginparams = array (
'sEmail' => 'someemail@domain.com',
'sPassword' => 'secretPassword'
);

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

//print the result
echo "<b>Login full response.</b><br />";		//formatting
print_r($loginResult);
echo "<br /><br />";					//formatting

$sAuthCode = "";

//define parameters
$reportarams = array (
'eReportArea' => '16',
'sAuthCode' => $sAuthCode
);

//login
$setReportArea_v6Result = $soapclient->setReportArea_v6($reportareaparams);

//print the result
echo "<b>setReportArea full response.</b><br />";	//formatting
print_r($setReportArea_v6Result);
echo "<br /><br />"; //formatting
?>

C# with HttpWebRequest

The example values shown must be replaced with actual values.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Net" %>
<%@ Import Namespace="System.IO" %>
<%@ Import Namespace="System" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <% 
     string sEndpoint = "https://secure.logmeinrescue.com/API/";  //add actionName.aspx? for each action called
     string sEmail = "some@email.com";
     string sPwd = "secretPassword";
     string sAuthCode = "";

     //set up the request
     HttpWebRequest oReq = (HttpWebRequest)System.Net.WebRequest.Create(sEndpoint + "login.aspx" + "?email=" 
+ sEmail + "&pwd=" + sPwd);
    
     //create a cookie container to store the cookies for this session 
     oReq.CookieContainer = new CookieContainer();
     
     
     //get the response
     HttpWebResponse oResp = (HttpWebResponse)oReq.GetResponse();

string sResp = new StreamReader(oResp.GetResponseStream()).ReadToEnd();
Response.Write("Login result: " + sResp + "<br />");  //You can customize the response

/*
//debug cookies
foreach (Cookie cook in oResp.Cookies)
{
Response.Write("Cookie:" + "<br />");
Response.Write("Name: " + cook.Name + " " + "Value: " + cook.Value + "<br />");
Response.Write("Domain: " + cook.Domain + "<br />");
Response.Write("Path: " + cook.Path + "<br />");
Response.Write("Port: " + cook.Port + "<br />");
Response.Write("Secure: " + cook.Secure + "<br />");

Response.Write("When issued: " + cook.TimeStamp + "<br />");
Response.Write("Expires: " + cook.Expires + " " + "Expired? " + cook.Expired + "<br />");
Response.Write("Don't save: " + cook.Discard + "<br />");
Response.Write("Comment: " + cook.Comment + "<br />");
Response.Write("Uri for comments: " + cook.CommentUri + "<br />");
Response.Write("Version: RFC " + cook.Version + "<br />");
    
// Show the string representation of the cookie.
Response.Write("String: " + cook.ToString());
}*/
     
//add cookies to cookie container
CookieContainer sessioncookie = oReq.CookieContainer;

//get the ReportArea info
string sReportArea = "16";  
HttpWebRequest oReqReportArea = (HttpWebRequest)System.Net.WebRequest.Create(sEndpoint 
+ "setReportArea._v6aspx?area=" + sReportArea + "&authcode=" + sAuthCode);
oReqReportArea.CookieContainer = sessioncookie;

HttpWebResponse oRespReportArea = (HttpWebResponse)oReqReportArea.GetResponse();
string sRespReportArea = new StreamReader(oRespReportArea.GetResponseStream()).ReadToEnd();
Response.Write("setReportArea result: " + sRespReportArea + "<br />");  //You can customize the response


%>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>Rescue API setReportArea_v6 Test</title>
</head>
<body>

</body>
</html>

C# with SOAP

The example values shown must be replaced with actual values.

using System;
using System.Net;
using apiSamples.WebServiceClients;

namespace apiSamples
{
    public partial class SOAP : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            try
            {
                WebServiceClients.API proxy = new WebServiceClients.API();
                proxy.CookieContainer = new CookieContainer();

                string sEmail = "some@email.com";
                string sPwd = "secretPassword";
                string sAuthCode = "4ahx...80u0";
                REPORT_V6 eReportArea = REPORT_V6.CHAT_LOG;

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

                WebServiceClients.setReportAreaRet oSetArea = proxy.setReportArea_v6(eReportArea, sAuthCode);
                Response.Write(oSetArea);
            }
            catch (Exception ex)
            {
                Response.Write(ex.Message);
            }
        }
    }
}