svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

GetSessionDetails

Request session details for the given sessionID

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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

<?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>
    <GetSessionDetails xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <ApplicationID>int</ApplicationID>
      <ApplicationVersion>string</ApplicationVersion>
    </GetSessionDetails>
  </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>
    <GetSessionDetailsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetSessionDetailsResult>
        <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>
        </UserInfo>
        <Locations>
          <LocationInfoBasic>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <PhotoURL>string</PhotoURL>
            <LocationModuleFlags>string</LocationModuleFlags>
            <SecurityDeviceID>long</SecurityDeviceID>
            <DeviceList xsi:nil="true" />
            <ServiceType>string</ServiceType>
            <CanSupportMultiPartition>int</CanSupportMultiPartition>
            <IsLocationToBeDisplayed>boolean</IsLocationToBeDisplayed>
          </LocationInfoBasic>
          <LocationInfoBasic>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <PhotoURL>string</PhotoURL>
            <LocationModuleFlags>string</LocationModuleFlags>
            <SecurityDeviceID>long</SecurityDeviceID>
            <DeviceList xsi:nil="true" />
            <ServiceType>string</ServiceType>
            <CanSupportMultiPartition>int</CanSupportMultiPartition>
            <IsLocationToBeDisplayed>boolean</IsLocationToBeDisplayed>
          </LocationInfoBasic>
        </Locations>
        <InterfaceSchemaConfigInfo>
          <AppleDownloadURL>string</AppleDownloadURL>
          <AndroidDownloadURL>string</AndroidDownloadURL>
          <LatestSupportedAppVersion>string</LatestSupportedAppVersion>
          <Whatsnew>string</Whatsnew>
          <SignalrHubUrl>string</SignalrHubUrl>
          <GatewayUrl>string</GatewayUrl>
        </InterfaceSchemaConfigInfo>
      </GetSessionDetailsResult>
    </GetSessionDetailsResponse>
  </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>
    <GetSessionDetails xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <ApplicationID>int</ApplicationID>
      <ApplicationVersion>string</ApplicationVersion>
    </GetSessionDetails>
  </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>
    <GetSessionDetailsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetSessionDetailsResult>
        <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>
        </UserInfo>
        <Locations>
          <LocationInfoBasic>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <PhotoURL>string</PhotoURL>
            <LocationModuleFlags>string</LocationModuleFlags>
            <SecurityDeviceID>long</SecurityDeviceID>
            <DeviceList xsi:nil="true" />
            <ServiceType>string</ServiceType>
            <CanSupportMultiPartition>int</CanSupportMultiPartition>
            <IsLocationToBeDisplayed>boolean</IsLocationToBeDisplayed>
          </LocationInfoBasic>
          <LocationInfoBasic>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <PhotoURL>string</PhotoURL>
            <LocationModuleFlags>string</LocationModuleFlags>
            <SecurityDeviceID>long</SecurityDeviceID>
            <DeviceList xsi:nil="true" />
            <ServiceType>string</ServiceType>
            <CanSupportMultiPartition>int</CanSupportMultiPartition>
            <IsLocationToBeDisplayed>boolean</IsLocationToBeDisplayed>
          </LocationInfoBasic>
        </Locations>
        <InterfaceSchemaConfigInfo>
          <AppleDownloadURL>string</AppleDownloadURL>
          <AndroidDownloadURL>string</AndroidDownloadURL>
          <LatestSupportedAppVersion>string</LatestSupportedAppVersion>
          <Whatsnew>string</Whatsnew>
          <SignalrHubUrl>string</SignalrHubUrl>
          <GatewayUrl>string</GatewayUrl>
        </InterfaceSchemaConfigInfo>
      </GetSessionDetailsResult>
    </GetSessionDetailsResponse>
  </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/GetSessionDetails?SessionID=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"?>
<SessionDetailResults 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>
  </UserInfo>
  <Locations>
    <LocationInfoBasic>
      <LocationID>long</LocationID>
      <LocationName>string</LocationName>
      <PhotoURL>string</PhotoURL>
      <LocationModuleFlags>string</LocationModuleFlags>
      <SecurityDeviceID>long</SecurityDeviceID>
      <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>
      <ServiceType>string</ServiceType>
      <CanSupportMultiPartition>int</CanSupportMultiPartition>
      <IsLocationToBeDisplayed>boolean</IsLocationToBeDisplayed>
    </LocationInfoBasic>
    <LocationInfoBasic>
      <LocationID>long</LocationID>
      <LocationName>string</LocationName>
      <PhotoURL>string</PhotoURL>
      <LocationModuleFlags>string</LocationModuleFlags>
      <SecurityDeviceID>long</SecurityDeviceID>
      <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>
      <ServiceType>string</ServiceType>
      <CanSupportMultiPartition>int</CanSupportMultiPartition>
      <IsLocationToBeDisplayed>boolean</IsLocationToBeDisplayed>
    </LocationInfoBasic>
  </Locations>
  <InterfaceSchemaConfigInfo>
    <AppleDownloadURL>string</AppleDownloadURL>
    <AndroidDownloadURL>string</AndroidDownloadURL>
    <LatestSupportedAppVersion>string</LatestSupportedAppVersion>
    <Whatsnew>string</Whatsnew>
    <SignalrHubUrl>string</SignalrHubUrl>
    <GatewayUrl>string</GatewayUrl>
  </InterfaceSchemaConfigInfo>
</SessionDetailResults>

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/GetSessionDetails HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=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"?>
<SessionDetailResults 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>
  </UserInfo>
  <Locations>
    <LocationInfoBasic>
      <LocationID>long</LocationID>
      <LocationName>string</LocationName>
      <PhotoURL>string</PhotoURL>
      <LocationModuleFlags>string</LocationModuleFlags>
      <SecurityDeviceID>long</SecurityDeviceID>
      <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>
      <ServiceType>string</ServiceType>
      <CanSupportMultiPartition>int</CanSupportMultiPartition>
      <IsLocationToBeDisplayed>boolean</IsLocationToBeDisplayed>
    </LocationInfoBasic>
    <LocationInfoBasic>
      <LocationID>long</LocationID>
      <LocationName>string</LocationName>
      <PhotoURL>string</PhotoURL>
      <LocationModuleFlags>string</LocationModuleFlags>
      <SecurityDeviceID>long</SecurityDeviceID>
      <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>
      <ServiceType>string</ServiceType>
      <CanSupportMultiPartition>int</CanSupportMultiPartition>
      <IsLocationToBeDisplayed>boolean</IsLocationToBeDisplayed>
    </LocationInfoBasic>
  </Locations>
  <InterfaceSchemaConfigInfo>
    <AppleDownloadURL>string</AppleDownloadURL>
    <AndroidDownloadURL>string</AndroidDownloadURL>
    <LatestSupportedAppVersion>string</LatestSupportedAppVersion>
    <Whatsnew>string</Whatsnew>
    <SignalrHubUrl>string</SignalrHubUrl>
    <GatewayUrl>string</GatewayUrl>
  </InterfaceSchemaConfigInfo>
</SessionDetailResults>

Parameter	Value
SessionID:
ApplicationID:
ApplicationVersion: