setReportTime

Sets the daily time range of reports. You can set the report time range in the Reports tab of the Rescue Administration Center. For information on reports, see Generating Reports in the LogMeIn Rescue Administration Center User Guide.

Note: Both setReportTime and setReportDate_v2 can set the time of your report period. The difference is that setReportDate_v2 sets the start and end time of your whole report period, whereas setReportTime sets a daily time range for every day of your report period. For example, you can define a report period between 12/1/2011 0:00:00 and 5/31/2012 23:59:59 with the setReportDate_v2 method. Then restrict reporting every day from 9:00 to 17:00 with the setReportTime method.

Input Parameters

Element	Description
`btime`	The start time of the report in H:MM:SS format. For example, 8:30:00. Required.
`etime`	The end time of the report in H:MM:SS format. For example, 18:30:00. Required.
`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 daily time range of the report succeeded.
`NOTLOGGEDIN`	Setting the daily time range of the report failed because the current user is no longer logged in.
`INVALIDFORMAT`	The time format is invalid.
`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 setReportTime method that you can call in your environment.

HTTP GET

https://secure.logmeinrescue.com/API/setReportTime.aspx?btime=8:30:00&etime=18:30:00
&authcode=4ahx...80u0

HTTP POST

<form method="post" action="https://secure.logmeinrescue.com/API/setReportTime.aspx">
        <input name="btime" value="8:30:00">
        <input name="etime" value="18:30:00">
        <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=setReportTime.

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' => 'some@email.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 = "4ahx...80u0";

//define parameters
$reporttimeparams = array (
'sBeginTime' => '8:30:00',
'sEndTime' => '18:30:00',
'sAuthCode' => $sAuthCode
);

//set the report time
$setReportTimeResult = $soapclient->setReportTime($reporttimeparams);

//print the result
echo "<b>setReportTime full response.</b><br />";	//formatting
print_r($setReportTimeResult);
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 = "4ahx...80u0";

     //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 ReportTime info
string sBTime = "8:30:00";
string sETime = "18:30:00";
HttpWebRequest oReqReportTime = (HttpWebRequest)System.Net.WebRequest.Create(sEndpoint
 + "setReportTime.aspx?btime=" + sBTime + "&etime=" + sETime + "&authcode=" + sAuthCode);
oReqReportTime.CookieContainer = sessioncookie;

HttpWebResponse oRespReportTime = (HttpWebResponse)oReqReportTime.GetResponse();
string sRespReportTime = new StreamReader(oRespReportTime.GetResponseStream()).ReadToEnd();
Response.Write("setReportTime result: " + sRespReportTime + "<br />");  //You can 
customize the response


%>

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

</body>
</html>

C# with SOAP

The example values shown must be replaced with actual values.

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
            {
                WebServiceClients.API proxy = new WebServiceClients.API();
                proxy.CookieContainer = new CookieContainer();

                string sEmail = "some@email.com";
                string sPwd = "secretPassword";
                string sAuthCode = "";
                string sBeginTime = "8:30:00";
                string sEndTime = "18:30:00";

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

                WebServiceClients.setReportTimeRet oSetTime = proxy.setReportTime
(sBeginTime, sEndTime, sAuthCode);
                Response.Write(oSetTime);
            }
            catch (Exception ex)
            {
                Response.Write(ex.Message);
            }
        }
    }
}