setDelimiter
Sets the delimiter characters for text-based output which cannot be of zero length. You cannot define a delimiter character in the Rescue Administration Center.
Input Parameters
Element | Description |
---|---|
delimiter | The delimiter character sequence. Required, default is '|' and it cannot be of zero length. |
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 delimiter character succeeded. |
NOTLOGGEDIN | Setting the delimiter character failed because the current user is no longer logged in. |
INVALIDPARAM_DELIMITER | The specified delimiter character 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 setDelimiter method that you can call in your environment.
HTTP GET
https://secure.logmeinrescue.com/API/setDelimiter.aspx?delimiter=-&authcode=4ahx...80u0
HTTP POST
<form method="post" action="https://secure.logmeinrescue.com/API/setDelimiter.aspx">
<input name="delimiter" value="-">
<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=setDelimiter.
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 = "";
//define parameters
$delimiterparams = array (
'sDelimiter' => '-',
'sAuthCode' => $sAuthCode
);
//set the delimiter
$setDelimiterResult = $soapclient->setDelimiter($delimiterparams);
//print the result
echo "<b>setDelimiter full response.</b><br />"; //formatting
print_r($setDelimiterResult);
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 Delimiter info
string sDelimiter = "-";
HttpWebRequest oReqDelimiter = (HttpWebRequest)System.Net.WebRequest.Create(sEndpoint
+ "setDelimiter.aspx?delimiter=" + sDelimiter + "&authcode=" + sAuthCode);
oReqDelimiter.CookieContainer = sessioncookie;
HttpWebResponse oRespDelimiter = (HttpWebResponse)oReqDelimiter.GetResponse();
string sRespDelimiter = new StreamReader(oRespDelimiter.GetResponseStream()).ReadToEnd();
Response.Write("setDelimiter result: " + sRespDelimiter + "<br />"); //You can
customize the response
%>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>Rescue API setDelimiter 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 = "4ahx...80u0";
string sDelimiter = "-";
WebServiceClients.loginRet oLogin = proxy.login(sEmail, sPwd);
Response.Write(oLogin + "<br />");
WebServiceClients.setDelimiterRet oSetDelimiter = proxy.setDelimiter
(sDelimiter, sAuthCode);
Response.Write(oSetDelimiter);
}
catch (Exception ex)
{
Response.Write(ex.Message);
}
}
}
}