svcTC2API


Click here for a complete list of operations.

LoginAndGetSessionDetailsEx

Request for authentication for the given username/password using the specified client application and retrieves the session details on successful authentication

Test

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

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/LoginAndGetSessionDetailsEx"

<?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>
    <LoginAndGetSessionDetailsEx xmlns="https://services.alarmnet.com/TC2/">
      <userName>string</userName>
      <password>string</password>
      <ApplicationID>int</ApplicationID>
      <ApplicationVersion>string</ApplicationVersion>
      <LocaleCode>string</LocaleCode>
    </LoginAndGetSessionDetailsEx>
  </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>
    <LoginAndGetSessionDetailsExResponse xmlns="https://services.alarmnet.com/TC2/">
      <LoginAndGetSessionDetailsExResult>
        <ModuleFlags>string</ModuleFlags>
        <SessionID>string</SessionID>
        <PrivacyStatementUrl>string</PrivacyStatementUrl>
        <UserInfo>
          <UserID>long</UserID>
          <Username>string</Username>
          <Fullname>string</Fullname>
          <Language>long</Language>
          <LocaleID>long</LocaleID>
          <UserFeatureList>string</UserFeatureList>
          <ClientPreferences>string</ClientPreferences>
          <IsEulaAccepted>boolean</IsEulaAccepted>
          <IsSMSEulaAccepted>boolean</IsSMSEulaAccepted>
          <DateFormatID>int</DateFormatID>
          <TimeFormatID>int</TimeFormatID>
          <PushNotificationStatus>short</PushNotificationStatus>
          <HasResetPassword>boolean</HasResetPassword>
          <IsRootedDeviceAccepted>boolean</IsRootedDeviceAccepted>
          <IsLocalyticsEnabled>int</IsLocalyticsEnabled>
          <IsAppStoreLogEnabled>int</IsAppStoreLogEnabled>
          <IsMarketingOptionEnabled>int</IsMarketingOptionEnabled>
          <IsMarketingDefaultValue>int</IsMarketingDefaultValue>
          <IsMonitoringDefaultValue>int</IsMonitoringDefaultValue>
          <IsOtpSupported>int</IsOtpSupported>
          <IsOtpEnabled>int</IsOtpEnabled>
          <UserOtpEmail>string</UserOtpEmail>
          <ForceResetPassword>boolean</ForceResetPassword>
          <UserCodeDirectPushEnabled>boolean</UserCodeDirectPushEnabled>
        </UserInfo>
        <Locations>
          <LocationInfoBasicEx>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <PhotoURL>string</PhotoURL>
            <LocationModuleFlags>string</LocationModuleFlags>
            <SecurityDeviceID>long</SecurityDeviceID>
            <LocationInfoSimple xsi:nil="true" />
            <PanelConnectionStatusInfo xsi:nil="true" />
            <DeviceList xsi:nil="true" />
          </LocationInfoBasicEx>
          <LocationInfoBasicEx>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <PhotoURL>string</PhotoURL>
            <LocationModuleFlags>string</LocationModuleFlags>
            <SecurityDeviceID>long</SecurityDeviceID>
            <LocationInfoSimple xsi:nil="true" />
            <PanelConnectionStatusInfo xsi:nil="true" />
            <DeviceList xsi:nil="true" />
          </LocationInfoBasicEx>
        </Locations>
        <InterfaceSchemaConfigInfo>
          <AppleDownloadURL>string</AppleDownloadURL>
          <AndroidDownloadURL>string</AndroidDownloadURL>
          <LatestSupportedAppVersion>string</LatestSupportedAppVersion>
          <Whatsnew>string</Whatsnew>
          <SignalrHubUrl>string</SignalrHubUrl>
          <GatewayUrl>string</GatewayUrl>
        </InterfaceSchemaConfigInfo>
      </LoginAndGetSessionDetailsExResult>
    </LoginAndGetSessionDetailsExResponse>
  </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>
    <LoginAndGetSessionDetailsEx xmlns="https://services.alarmnet.com/TC2/">
      <userName>string</userName>
      <password>string</password>
      <ApplicationID>int</ApplicationID>
      <ApplicationVersion>string</ApplicationVersion>
      <LocaleCode>string</LocaleCode>
    </LoginAndGetSessionDetailsEx>
  </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>
    <LoginAndGetSessionDetailsExResponse xmlns="https://services.alarmnet.com/TC2/">
      <LoginAndGetSessionDetailsExResult>
        <ModuleFlags>string</ModuleFlags>
        <SessionID>string</SessionID>
        <PrivacyStatementUrl>string</PrivacyStatementUrl>
        <UserInfo>
          <UserID>long</UserID>
          <Username>string</Username>
          <Fullname>string</Fullname>
          <Language>long</Language>
          <LocaleID>long</LocaleID>
          <UserFeatureList>string</UserFeatureList>
          <ClientPreferences>string</ClientPreferences>
          <IsEulaAccepted>boolean</IsEulaAccepted>
          <IsSMSEulaAccepted>boolean</IsSMSEulaAccepted>
          <DateFormatID>int</DateFormatID>
          <TimeFormatID>int</TimeFormatID>
          <PushNotificationStatus>short</PushNotificationStatus>
          <HasResetPassword>boolean</HasResetPassword>
          <IsRootedDeviceAccepted>boolean</IsRootedDeviceAccepted>
          <IsLocalyticsEnabled>int</IsLocalyticsEnabled>
          <IsAppStoreLogEnabled>int</IsAppStoreLogEnabled>
          <IsMarketingOptionEnabled>int</IsMarketingOptionEnabled>
          <IsMarketingDefaultValue>int</IsMarketingDefaultValue>
          <IsMonitoringDefaultValue>int</IsMonitoringDefaultValue>
          <IsOtpSupported>int</IsOtpSupported>
          <IsOtpEnabled>int</IsOtpEnabled>
          <UserOtpEmail>string</UserOtpEmail>
          <ForceResetPassword>boolean</ForceResetPassword>
          <UserCodeDirectPushEnabled>boolean</UserCodeDirectPushEnabled>
        </UserInfo>
        <Locations>
          <LocationInfoBasicEx>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <PhotoURL>string</PhotoURL>
            <LocationModuleFlags>string</LocationModuleFlags>
            <SecurityDeviceID>long</SecurityDeviceID>
            <LocationInfoSimple xsi:nil="true" />
            <PanelConnectionStatusInfo xsi:nil="true" />
            <DeviceList xsi:nil="true" />
          </LocationInfoBasicEx>
          <LocationInfoBasicEx>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <PhotoURL>string</PhotoURL>
            <LocationModuleFlags>string</LocationModuleFlags>
            <SecurityDeviceID>long</SecurityDeviceID>
            <LocationInfoSimple xsi:nil="true" />
            <PanelConnectionStatusInfo xsi:nil="true" />
            <DeviceList xsi:nil="true" />
          </LocationInfoBasicEx>
        </Locations>
        <InterfaceSchemaConfigInfo>
          <AppleDownloadURL>string</AppleDownloadURL>
          <AndroidDownloadURL>string</AndroidDownloadURL>
          <LatestSupportedAppVersion>string</LatestSupportedAppVersion>
          <Whatsnew>string</Whatsnew>
          <SignalrHubUrl>string</SignalrHubUrl>
          <GatewayUrl>string</GatewayUrl>
        </InterfaceSchemaConfigInfo>
      </LoginAndGetSessionDetailsExResult>
    </LoginAndGetSessionDetailsExResponse>
  </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/LoginAndGetSessionDetailsEx?userName=string&password=string&ApplicationID=string&ApplicationVersion=string&LocaleCode=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"?>
<SessionDetailResultsEx xmlns="https://services.alarmnet.com/TC2/">
  <ModuleFlags>string</ModuleFlags>
  <SessionID>string</SessionID>
  <PrivacyStatementUrl>string</PrivacyStatementUrl>
  <UserInfo>
    <UserID>long</UserID>
    <Username>string</Username>
    <Fullname>string</Fullname>
    <Language>long</Language>
    <LocaleID>long</LocaleID>
    <UserFeatureList>string</UserFeatureList>
    <ClientPreferences>string</ClientPreferences>
    <IsEulaAccepted>boolean</IsEulaAccepted>
    <IsSMSEulaAccepted>boolean</IsSMSEulaAccepted>
    <DateFormatID>int</DateFormatID>
    <TimeFormatID>int</TimeFormatID>
    <PushNotificationStatus>short</PushNotificationStatus>
    <HasResetPassword>boolean</HasResetPassword>
    <IsRootedDeviceAccepted>boolean</IsRootedDeviceAccepted>
    <IsLocalyticsEnabled>int</IsLocalyticsEnabled>
    <IsAppStoreLogEnabled>int</IsAppStoreLogEnabled>
    <IsMarketingOptionEnabled>int</IsMarketingOptionEnabled>
    <IsMarketingDefaultValue>int</IsMarketingDefaultValue>
    <IsMonitoringDefaultValue>int</IsMonitoringDefaultValue>
    <IsOtpSupported>int</IsOtpSupported>
    <IsOtpEnabled>int</IsOtpEnabled>
    <UserOtpEmail>string</UserOtpEmail>
    <ForceResetPassword>boolean</ForceResetPassword>
    <UserCodeDirectPushEnabled>boolean</UserCodeDirectPushEnabled>
  </UserInfo>
  <Locations>
    <LocationInfoBasicEx>
      <LocationID>long</LocationID>
      <LocationName>string</LocationName>
      <PhotoURL>string</PhotoURL>
      <LocationModuleFlags>string</LocationModuleFlags>
      <SecurityDeviceID>long</SecurityDeviceID>
      <LocationInfoSimple>
        <LocationId>long</LocationId>
        <LocationName>string</LocationName>
        <AccountId>long</AccountId>
        <PhotoId>long</PhotoId>
        <TimeZoneId>int</TimeZoneId>
        <PhotoURL>string</PhotoURL>
        <SetDefaultLocationName>boolean</SetDefaultLocationName>
        <SecuritySystemAlias>string</SecuritySystemAlias>
        <SecuritySystemPanelDeviceID>long</SecuritySystemPanelDeviceID>
        <CountryID>long</CountryID>
        <StreetNumber>string</StreetNumber>
        <StreetName>string</StreetName>
        <City>string</City>
        <StateID>long</StateID>
        <PostalCode>string</PostalCode>
        <TemperatureUnits>string</TemperatureUnits>
        <Latitude>string</Latitude>
        <Longitude>string</Longitude>
      </LocationInfoSimple>
      <PanelConnectionStatusInfo>
        <PanelConnectionStatusInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <PanelConnectionStatusInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </PanelConnectionStatusInfo>
      <DeviceList>
        <DeviceInfoBasic d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DeviceInfoBasic d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </DeviceList>
    </LocationInfoBasicEx>
    <LocationInfoBasicEx>
      <LocationID>long</LocationID>
      <LocationName>string</LocationName>
      <PhotoURL>string</PhotoURL>
      <LocationModuleFlags>string</LocationModuleFlags>
      <SecurityDeviceID>long</SecurityDeviceID>
      <LocationInfoSimple>
        <LocationId>long</LocationId>
        <LocationName>string</LocationName>
        <AccountId>long</AccountId>
        <PhotoId>long</PhotoId>
        <TimeZoneId>int</TimeZoneId>
        <PhotoURL>string</PhotoURL>
        <SetDefaultLocationName>boolean</SetDefaultLocationName>
        <SecuritySystemAlias>string</SecuritySystemAlias>
        <SecuritySystemPanelDeviceID>long</SecuritySystemPanelDeviceID>
        <CountryID>long</CountryID>
        <StreetNumber>string</StreetNumber>
        <StreetName>string</StreetName>
        <City>string</City>
        <StateID>long</StateID>
        <PostalCode>string</PostalCode>
        <TemperatureUnits>string</TemperatureUnits>
        <Latitude>string</Latitude>
        <Longitude>string</Longitude>
      </LocationInfoSimple>
      <PanelConnectionStatusInfo>
        <PanelConnectionStatusInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <PanelConnectionStatusInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </PanelConnectionStatusInfo>
      <DeviceList>
        <DeviceInfoBasic d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DeviceInfoBasic d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </DeviceList>
    </LocationInfoBasicEx>
  </Locations>
  <InterfaceSchemaConfigInfo>
    <AppleDownloadURL>string</AppleDownloadURL>
    <AndroidDownloadURL>string</AndroidDownloadURL>
    <LatestSupportedAppVersion>string</LatestSupportedAppVersion>
    <Whatsnew>string</Whatsnew>
    <SignalrHubUrl>string</SignalrHubUrl>
    <GatewayUrl>string</GatewayUrl>
  </InterfaceSchemaConfigInfo>
</SessionDetailResultsEx>

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/LoginAndGetSessionDetailsEx 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&LocaleCode=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SessionDetailResultsEx xmlns="https://services.alarmnet.com/TC2/">
  <ModuleFlags>string</ModuleFlags>
  <SessionID>string</SessionID>
  <PrivacyStatementUrl>string</PrivacyStatementUrl>
  <UserInfo>
    <UserID>long</UserID>
    <Username>string</Username>
    <Fullname>string</Fullname>
    <Language>long</Language>
    <LocaleID>long</LocaleID>
    <UserFeatureList>string</UserFeatureList>
    <ClientPreferences>string</ClientPreferences>
    <IsEulaAccepted>boolean</IsEulaAccepted>
    <IsSMSEulaAccepted>boolean</IsSMSEulaAccepted>
    <DateFormatID>int</DateFormatID>
    <TimeFormatID>int</TimeFormatID>
    <PushNotificationStatus>short</PushNotificationStatus>
    <HasResetPassword>boolean</HasResetPassword>
    <IsRootedDeviceAccepted>boolean</IsRootedDeviceAccepted>
    <IsLocalyticsEnabled>int</IsLocalyticsEnabled>
    <IsAppStoreLogEnabled>int</IsAppStoreLogEnabled>
    <IsMarketingOptionEnabled>int</IsMarketingOptionEnabled>
    <IsMarketingDefaultValue>int</IsMarketingDefaultValue>
    <IsMonitoringDefaultValue>int</IsMonitoringDefaultValue>
    <IsOtpSupported>int</IsOtpSupported>
    <IsOtpEnabled>int</IsOtpEnabled>
    <UserOtpEmail>string</UserOtpEmail>
    <ForceResetPassword>boolean</ForceResetPassword>
    <UserCodeDirectPushEnabled>boolean</UserCodeDirectPushEnabled>
  </UserInfo>
  <Locations>
    <LocationInfoBasicEx>
      <LocationID>long</LocationID>
      <LocationName>string</LocationName>
      <PhotoURL>string</PhotoURL>
      <LocationModuleFlags>string</LocationModuleFlags>
      <SecurityDeviceID>long</SecurityDeviceID>
      <LocationInfoSimple>
        <LocationId>long</LocationId>
        <LocationName>string</LocationName>
        <AccountId>long</AccountId>
        <PhotoId>long</PhotoId>
        <TimeZoneId>int</TimeZoneId>
        <PhotoURL>string</PhotoURL>
        <SetDefaultLocationName>boolean</SetDefaultLocationName>
        <SecuritySystemAlias>string</SecuritySystemAlias>
        <SecuritySystemPanelDeviceID>long</SecuritySystemPanelDeviceID>
        <CountryID>long</CountryID>
        <StreetNumber>string</StreetNumber>
        <StreetName>string</StreetName>
        <City>string</City>
        <StateID>long</StateID>
        <PostalCode>string</PostalCode>
        <TemperatureUnits>string</TemperatureUnits>
        <Latitude>string</Latitude>
        <Longitude>string</Longitude>
      </LocationInfoSimple>
      <PanelConnectionStatusInfo>
        <PanelConnectionStatusInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <PanelConnectionStatusInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </PanelConnectionStatusInfo>
      <DeviceList>
        <DeviceInfoBasic d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DeviceInfoBasic d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </DeviceList>
    </LocationInfoBasicEx>
    <LocationInfoBasicEx>
      <LocationID>long</LocationID>
      <LocationName>string</LocationName>
      <PhotoURL>string</PhotoURL>
      <LocationModuleFlags>string</LocationModuleFlags>
      <SecurityDeviceID>long</SecurityDeviceID>
      <LocationInfoSimple>
        <LocationId>long</LocationId>
        <LocationName>string</LocationName>
        <AccountId>long</AccountId>
        <PhotoId>long</PhotoId>
        <TimeZoneId>int</TimeZoneId>
        <PhotoURL>string</PhotoURL>
        <SetDefaultLocationName>boolean</SetDefaultLocationName>
        <SecuritySystemAlias>string</SecuritySystemAlias>
        <SecuritySystemPanelDeviceID>long</SecuritySystemPanelDeviceID>
        <CountryID>long</CountryID>
        <StreetNumber>string</StreetNumber>
        <StreetName>string</StreetName>
        <City>string</City>
        <StateID>long</StateID>
        <PostalCode>string</PostalCode>
        <TemperatureUnits>string</TemperatureUnits>
        <Latitude>string</Latitude>
        <Longitude>string</Longitude>
      </LocationInfoSimple>
      <PanelConnectionStatusInfo>
        <PanelConnectionStatusInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <PanelConnectionStatusInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </PanelConnectionStatusInfo>
      <DeviceList>
        <DeviceInfoBasic d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DeviceInfoBasic d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </DeviceList>
    </LocationInfoBasicEx>
  </Locations>
  <InterfaceSchemaConfigInfo>
    <AppleDownloadURL>string</AppleDownloadURL>
    <AndroidDownloadURL>string</AndroidDownloadURL>
    <LatestSupportedAppVersion>string</LatestSupportedAppVersion>
    <Whatsnew>string</Whatsnew>
    <SignalrHubUrl>string</SignalrHubUrl>
    <GatewayUrl>string</GatewayUrl>
  </InterfaceSchemaConfigInfo>
</SessionDetailResultsEx>