API Web Service

API

Click here for a complete list of operations.

getSession

Retrieves the current sessions of any hierarchy node

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /API/API.asmx HTTP/1.1
Host: secure.logmeinrescue.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://secure.logmeinrescue.com/API/API.asmx/getSession"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSession xmlns="https://secure.logmeinrescue.com/API/API.asmx">
      <iNodeID>int</iNodeID>
      <eNodeRef>NODE or CHANNEL</eNodeRef>
      <sAuthCode>string</sAuthCode>
    </getSession>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getSessionResponse xmlns="https://secure.logmeinrescue.com/API/API.asmx">
      <getSessionResult>getSession_Error or getSession_OK or getSession_NotLoggedIn or getSession_InvalidParam_NodeID or getSession_Invalid_SecretAuthCode or getSession_User_Deleted_Or_Disabled</getSessionResult>
      <aSessions>
        <SESSION>
          <iID>int</iID>
          <bStatus>SESSION_STARTING or SESSION_CONNECTING or SESSION_WAITING or SESSION_PICKEDUP or SESSION_CLOSEDBYCUSTOMER or SESSION_CLOSEDBYTECHNICIAN or SESSION_TRANSFERINGBUTNOTPICKEDUP or SESSION_REVOKED or SESSION_CLOSED_TRANSFERREDANOTHERTECH_WITHOUTPICKUP or SESSION_CUSTOMERLEFTSESSION_WASNOTPICKEDUP or SESSION_WAITINGTIMEOUT_PICKEDUP or SESSION_WAITINGTIMEOUT_NOTPICKEDUP or SESSION_SYSTEMTIMEOUT_PICKEDUP or SESSION_SYSTEMTIMEOUT_NOTPICKEDUP or SESSION_ABORTED_TECHDELETEDORDISABLED or SESSION_CLOSED_TRANSFERREDANOTHERTECH or SESSION_REBOOTING or SESSION_CONNECTIONPROBLEM or SESSION_ONHOLD or SESSION_ONHOLDBUTCUSTOMERLEFT or SESSION_TIMEOUT_SESSIONIDLETECHSIDE or SESSION_OFFLINE or SESSION_CUSTOMERLEFTSESSION_DURINGTRANSFER_WITHOUTPICKUP or SESSION_CUSTOMERLEFTSESSION_DURINGTRANSFER or SESSION_CLOSEDBYWAITINGCUSTOMER or SESSION_CLOSEDBYACTIVECUSTOMER or SESSION_CLOSED_DURINGRECONNECTING or SESSION_CLOSED_DURINGREBOOTING or SESSION_TIMEOUT_TECHCONNECTIONLOSTORSESSIONWASNOTCLOSEDBYTECH</bStatus>
          <sStatus>string</sStatus>
          <iEntry>int</iEntry>
          <sEntry>string</sEntry>
          <iTechnician>int</iTechnician>
          <sTechnician>string</sTechnician>
          <sStartTime>string</sStartTime>
          <iWaitingTimeInSec>int</iWaitingTimeInSec>
          <sCustomField0>string</sCustomField0>
          <sCustomField1>string</sCustomField1>
          <sCustomField2>string</sCustomField2>
          <sLanguage>string</sLanguage>
          <sTransferredTo>string</sTransferredTo>
          <sTransferredComment>string</sTransferredComment>
        </SESSION>
        <SESSION>
          <iID>int</iID>
          <bStatus>SESSION_STARTING or SESSION_CONNECTING or SESSION_WAITING or SESSION_PICKEDUP or SESSION_CLOSEDBYCUSTOMER or SESSION_CLOSEDBYTECHNICIAN or SESSION_TRANSFERINGBUTNOTPICKEDUP or SESSION_REVOKED or SESSION_CLOSED_TRANSFERREDANOTHERTECH_WITHOUTPICKUP or SESSION_CUSTOMERLEFTSESSION_WASNOTPICKEDUP or SESSION_WAITINGTIMEOUT_PICKEDUP or SESSION_WAITINGTIMEOUT_NOTPICKEDUP or SESSION_SYSTEMTIMEOUT_PICKEDUP or SESSION_SYSTEMTIMEOUT_NOTPICKEDUP or SESSION_ABORTED_TECHDELETEDORDISABLED or SESSION_CLOSED_TRANSFERREDANOTHERTECH or SESSION_REBOOTING or SESSION_CONNECTIONPROBLEM or SESSION_ONHOLD or SESSION_ONHOLDBUTCUSTOMERLEFT or SESSION_TIMEOUT_SESSIONIDLETECHSIDE or SESSION_OFFLINE or SESSION_CUSTOMERLEFTSESSION_DURINGTRANSFER_WITHOUTPICKUP or SESSION_CUSTOMERLEFTSESSION_DURINGTRANSFER or SESSION_CLOSEDBYWAITINGCUSTOMER or SESSION_CLOSEDBYACTIVECUSTOMER or SESSION_CLOSED_DURINGRECONNECTING or SESSION_CLOSED_DURINGREBOOTING or SESSION_TIMEOUT_TECHCONNECTIONLOSTORSESSIONWASNOTCLOSEDBYTECH</bStatus>
          <sStatus>string</sStatus>
          <iEntry>int</iEntry>
          <sEntry>string</sEntry>
          <iTechnician>int</iTechnician>
          <sTechnician>string</sTechnician>
          <sStartTime>string</sStartTime>
          <iWaitingTimeInSec>int</iWaitingTimeInSec>
          <sCustomField0>string</sCustomField0>
          <sCustomField1>string</sCustomField1>
          <sCustomField2>string</sCustomField2>
          <sLanguage>string</sLanguage>
          <sTransferredTo>string</sTransferredTo>
          <sTransferredComment>string</sTransferredComment>
        </SESSION>
      </aSessions>
    </getSessionResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /API/API.asmx HTTP/1.1
Host: secure.logmeinrescue.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSession xmlns="https://secure.logmeinrescue.com/API/API.asmx">
      <iNodeID>int</iNodeID>
      <eNodeRef>NODE or CHANNEL</eNodeRef>
      <sAuthCode>string</sAuthCode>
    </getSession>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getSessionResponse xmlns="https://secure.logmeinrescue.com/API/API.asmx">
      <getSessionResult>getSession_Error or getSession_OK or getSession_NotLoggedIn or getSession_InvalidParam_NodeID or getSession_Invalid_SecretAuthCode or getSession_User_Deleted_Or_Disabled</getSessionResult>
      <aSessions>
        <SESSION>
          <iID>int</iID>
          <bStatus>SESSION_STARTING or SESSION_CONNECTING or SESSION_WAITING or SESSION_PICKEDUP or SESSION_CLOSEDBYCUSTOMER or SESSION_CLOSEDBYTECHNICIAN or SESSION_TRANSFERINGBUTNOTPICKEDUP or SESSION_REVOKED or SESSION_CLOSED_TRANSFERREDANOTHERTECH_WITHOUTPICKUP or SESSION_CUSTOMERLEFTSESSION_WASNOTPICKEDUP or SESSION_WAITINGTIMEOUT_PICKEDUP or SESSION_WAITINGTIMEOUT_NOTPICKEDUP or SESSION_SYSTEMTIMEOUT_PICKEDUP or SESSION_SYSTEMTIMEOUT_NOTPICKEDUP or SESSION_ABORTED_TECHDELETEDORDISABLED or SESSION_CLOSED_TRANSFERREDANOTHERTECH or SESSION_REBOOTING or SESSION_CONNECTIONPROBLEM or SESSION_ONHOLD or SESSION_ONHOLDBUTCUSTOMERLEFT or SESSION_TIMEOUT_SESSIONIDLETECHSIDE or SESSION_OFFLINE or SESSION_CUSTOMERLEFTSESSION_DURINGTRANSFER_WITHOUTPICKUP or SESSION_CUSTOMERLEFTSESSION_DURINGTRANSFER or SESSION_CLOSEDBYWAITINGCUSTOMER or SESSION_CLOSEDBYACTIVECUSTOMER or SESSION_CLOSED_DURINGRECONNECTING or SESSION_CLOSED_DURINGREBOOTING or SESSION_TIMEOUT_TECHCONNECTIONLOSTORSESSIONWASNOTCLOSEDBYTECH</bStatus>
          <sStatus>string</sStatus>
          <iEntry>int</iEntry>
          <sEntry>string</sEntry>
          <iTechnician>int</iTechnician>
          <sTechnician>string</sTechnician>
          <sStartTime>string</sStartTime>
          <iWaitingTimeInSec>int</iWaitingTimeInSec>
          <sCustomField0>string</sCustomField0>
          <sCustomField1>string</sCustomField1>
          <sCustomField2>string</sCustomField2>
          <sLanguage>string</sLanguage>
          <sTransferredTo>string</sTransferredTo>
          <sTransferredComment>string</sTransferredComment>
        </SESSION>
        <SESSION>
          <iID>int</iID>
          <bStatus>SESSION_STARTING or SESSION_CONNECTING or SESSION_WAITING or SESSION_PICKEDUP or SESSION_CLOSEDBYCUSTOMER or SESSION_CLOSEDBYTECHNICIAN or SESSION_TRANSFERINGBUTNOTPICKEDUP or SESSION_REVOKED or SESSION_CLOSED_TRANSFERREDANOTHERTECH_WITHOUTPICKUP or SESSION_CUSTOMERLEFTSESSION_WASNOTPICKEDUP or SESSION_WAITINGTIMEOUT_PICKEDUP or SESSION_WAITINGTIMEOUT_NOTPICKEDUP or SESSION_SYSTEMTIMEOUT_PICKEDUP or SESSION_SYSTEMTIMEOUT_NOTPICKEDUP or SESSION_ABORTED_TECHDELETEDORDISABLED or SESSION_CLOSED_TRANSFERREDANOTHERTECH or SESSION_REBOOTING or SESSION_CONNECTIONPROBLEM or SESSION_ONHOLD or SESSION_ONHOLDBUTCUSTOMERLEFT or SESSION_TIMEOUT_SESSIONIDLETECHSIDE or SESSION_OFFLINE or SESSION_CUSTOMERLEFTSESSION_DURINGTRANSFER_WITHOUTPICKUP or SESSION_CUSTOMERLEFTSESSION_DURINGTRANSFER or SESSION_CLOSEDBYWAITINGCUSTOMER or SESSION_CLOSEDBYACTIVECUSTOMER or SESSION_CLOSED_DURINGRECONNECTING or SESSION_CLOSED_DURINGREBOOTING or SESSION_TIMEOUT_TECHCONNECTIONLOSTORSESSIONWASNOTCLOSEDBYTECH</bStatus>
          <sStatus>string</sStatus>
          <iEntry>int</iEntry>
          <sEntry>string</sEntry>
          <iTechnician>int</iTechnician>
          <sTechnician>string</sTechnician>
          <sStartTime>string</sStartTime>
          <iWaitingTimeInSec>int</iWaitingTimeInSec>
          <sCustomField0>string</sCustomField0>
          <sCustomField1>string</sCustomField1>
          <sCustomField2>string</sCustomField2>
          <sLanguage>string</sLanguage>
          <sTransferredTo>string</sTransferredTo>
          <sTransferredComment>string</sTransferredComment>
        </SESSION>
      </aSessions>
    </getSessionResponse>
  </soap12:Body>
</soap12:Envelope>