svcTC2API


Click here for a complete list of operations.

AuthenticateUserLogin

Request for authentication for the given username/password using the specified client application.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
userName:
password:
ApplicationID:
ApplicationVersion:

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 /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.alarmnet.com/TC2/AuthenticateUserLogin"

<?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>
    <AuthenticateUserLogin xmlns="https://services.alarmnet.com/TC2/">
      <userName>string</userName>
      <password>string</password>
      <ApplicationID>int</ApplicationID>
      <ApplicationVersion>string</ApplicationVersion>
    </AuthenticateUserLogin>
  </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>
    <AuthenticateUserLoginResponse xmlns="https://services.alarmnet.com/TC2/">
      <AuthenticateUserLoginResult>
        <SessionID>string</SessionID>
      </AuthenticateUserLoginResult>
    </AuthenticateUserLoginResponse>
  </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 /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.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>
    <AuthenticateUserLogin xmlns="https://services.alarmnet.com/TC2/">
      <userName>string</userName>
      <password>string</password>
      <ApplicationID>int</ApplicationID>
      <ApplicationVersion>string</ApplicationVersion>
    </AuthenticateUserLogin>
  </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>
    <AuthenticateUserLoginResponse xmlns="https://services.alarmnet.com/TC2/">
      <AuthenticateUserLoginResult>
        <SessionID>string</SessionID>
      </AuthenticateUserLoginResult>
    </AuthenticateUserLoginResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /tc21api/tc2.asmx/AuthenticateUserLogin?userName=string&password=string&ApplicationID=string&ApplicationVersion=string HTTP/1.1
Host: rs.alarmnet.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AuthenticateLoginResults xmlns="https://services.alarmnet.com/TC2/">
  <SessionID>string</SessionID>
</AuthenticateLoginResults>

HTTP POST

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

POST /tc21api/tc2.asmx/AuthenticateUserLogin HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&password=string&ApplicationID=string&ApplicationVersion=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AuthenticateLoginResults xmlns="https://services.alarmnet.com/TC2/">
  <SessionID>string</SessionID>
</AuthenticateLoginResults>