TotalConnect2 Web API Help Page

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

Get all automation devices - Includes switch, lock and Thermostats.

Get All Automation Swithes

To get the list of EULA's to be signed by the user. SOAP API : GetEulaInfo

To get the EULA Text for the given language id and eula id. SOAP API : GetEulaText

To get the privacy Text for the given language id and eula id.

To get the list of All EULA's befor login to be viewed by the user. SOAP API : GetPreLoginEulaInfo

To get the EULA Text for the given language id and eula id. SOAP API : GetPreLoginEulaText

To update if the device is insecure. SOAP API : AcceptRootedDeviceUsage

To update if the device is insecure. SOAP API : signEULA

This Api Generate an OTP and send to the given Email

This Api is for validate the OTP which has sent to the given Email

This Api is to get the MFA settings

This Api is for getting the Validated Email List.

Return list of partitions for the given device Id

Request for Metadata and Full status of Security Panel for the Given Location and User.Added CanBeBypassable flag to determine zone is bypassable or not

[TC2.1+] R Get the zones in different states like Alarms, Faults, Trouble, and Bypassed and whether it is Bypassable Zone or Not for Multipartition

Get the Panel connection Info from DFC Producer

Returns the current connection status of the security panel

Return List of Zone Informations for given ZoneId's Equivalent SOAP API: GetIndividualZoneDetails

No documentation available.

[Enriched Method] Get the zones in different states like Alarms, Faults, Trouble, and Bypassed and whether it is Bypassable Zone or Not")]

Request for Metadata and Full status of Security Panel and alarm staus (sensor tripped or user generated) for the Given Location and User.Added CanBeBypassable flag to determine zone is bypassable or not

Request for Full status of Security Panel for the Given Location and User.Added CanBeBypassable flag to determine zone is bypassable or not

Polling API - Which should be called based on Arm/Disarm API output Result Codes

Polling API - to display 16x2 Aplha Keypad Display and Led Status of the security System

Request for PanelMetadata and security status of each partition for the Given Location and User.

Retrieves latest custom Arm settings set by the user Equivalent SOAP API : GetCustomArmSettings

To enable and configure feature for each partition by master user

Sends Keystroke to the Security Panel

Establishes Live Connection to Security System Equivalent SOAP API : ConnectToPanel

Close Current Security Panel Session Equivalent SOAP API : DisconnectPanel

Arm the Security System

Disarm the Security System

Refresh or Insert a Command for a Security Panel

Update User's Geofence Area selection - includes Latitude, Longitude and Radius

Configuring enabled feature for each partition-master user

Initiates Zone Bypass for multiple zones

Polling API - Which should be called based on Arm/Disarm API output Result Codes

Retrieves latest custom Arm settings set by the user Equivalent SOAP API : GetCustomArmSettings

Arm the Security System

Disarm the Security System

Activate BLE mode in Panel

Disarm the Security System

Arm the Security System

Disarm the Security System

Arm the Security System

Disarm the Security System

Gets the interface schema details.

Gets the interface schema details.

Gets the interface schema details.

The ServiceVersion() web method provides version information for the web service.

Returns a set of device or audit event records. A maximum of 100 records can be returned per call.Eevnts by partition (This method is used HttpPost action. Reason: "EventFilters" input model pass more inbound params.)

Returns a list of available event type filter values that are to be used for filtering the event record retrieval.

Retrieves the set of video file URLs for a device or audit event record

Updates the lock state of a device or audit event record. When a record is locked, the automated clean up process will retain the locked record. Only unlocked records will be removed.

This method is return to all location deatails

This method is return to location deatails by given location id

Returns the data associated with a Location object from the database EQUIVALENT SOAP API : GetLocation by location ID

This method Returns the list of list of states for a country Equivalent SOAP API : GetCountryStateList

Get Device status details will return Lock and security device status Equivalent SOAP API : GetDeviceStatus

Get location all camera list Equivalent SOAP API : GetLocationAllCameraListEx

Saves the data associated with a LocationInfo object to the database. Since this method will only update an existing Location, you are required to pass in its LocationId. Pass in a null value for the Image byte array when either the image has not changed or when the default image Is to be used. Any previous image will be deleted when either a null or actual image is saved. At the curent triggerTime, the Alias is for the one security system associated with this location

Multiple Skybell Returns the Partners associated with a Location object from the database

Used to update the usercode after login, so sessionid, oldUsercode, NewUserCode, UserId, LocationID is must Equivalent SOAP API : UpdateUserCode

Used to update the usercode after login, so sessionid, oldUsercode, NewUserCode, UserId, LocationID is must Equivalent SOAP API : UpdateUserCode

Used to update the Location Module flags after login, so sessionid, LocationID is must

Used to acknowledge the usercode length changes useridBaseResults

No documentation available.

To Get SkyBell Device Invite token to start SkyBell Setup

Return Device provisioning status for the given token.

This API provides the WiFi Door Bell details.

This API provides the WiFi Door Bell details.

This api get the WifiDoorBell Settings and Name

This api provides the list of skybell devices along with configuration status in TC

This api provides the video URL for the given event of a doorbell

Get DoorBell - Client ID

This API provides the WiFi Door Bell Diagnostic details.

This API provides the Associated Partner details.

Update DoorBell details to be called for Doorbell Initial configuration setup and Enrollment of existing skybell user and to update the details of Doorbell details.

Updates the DoorBell settings to Skybell and Device Name to TC DB

This api is used to delete the user from partner and delete doorbell from TC

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

Retrieve the configuration settings for all the Content

Retrieve the current weather condition

Retrieve the five days forecast weather condition

Retrieve the top 5 dealer messages

Retrieve the current weather condition with url

Retrieve the five days forecast weather condition with url

Mark a dealer message as Read

Save the configuration settings for all the Content

Request for Metadata and Full status of Security Panel and alarm staus (sensor tripped or user generated) for the Given Location and User.Added CanBeBypassable flag to determine zone is bypassable or not

Returns the current connection status of the security panel

Request for Full status of Security Panel for the Given Location and User.Added CanBeBypassable flag to determine zone is bypassable or not

Polling API - Which should be called based on Arm/Disarm API output Result Codes

The GetCameraConfiguration Web PopulateResults is used to retrieve the current configuration data for the given camera.

The GetFirmwareList() method is used to request the list of available firmware revisions for the given camera.

Get camera wireless status

Get camera Information - provides camera wireless details and Network data

The GetLocationCameraList() method is used to retrieve a list of all cameras for the given sessionID and location.

Retrieve the current I/O state (flags, WLLED, output state) for the given camera.

The UpdateCameraConfiguration Web PopulateResults is used to save configuration changes to the given camera.

The UpgradeCameraFirmware() method is used to request that the given camera be upgraded to the requested firmware revision.

The WLLED_Control Web PopulateResults is used to control the state of the white-light LEDs for the given camera.

The StorePreset Web Method is used to request that the current pan/tilt position be saved in the requested preset slot number for the given camera.

The GotoPreset Web PopulateResults is used to request that the camera be moved to the position defined by the given preset slot number.

The MoveCamera method is used to request that the camera be moved in the specified direction by the specified PAN and TILT values.

The TriggerVideoCapture() Web PopulateResults is used to force the camera to trigger a video capture event, which will result in a video (or jpg) clip being saved to the AlarmNet video servers, if the camera is previously configured to do so.

The TriggerVideoCapture() Web PopulateResults is used to force the IMV to trigger a video capture event, which will result in a video (or jpg) clip being saved to the AlarmNet video/TMS servers, if the device is previously configured to do so.

Configure the given camera to use the specified video mode.

Return a list of Lyric locations and devices. Equivalent SOAP API : GetLyricLocations

No documentation available.

Activate and Remove Lyric Thermostat in Total Connect. Equivalent SOAP API : GetWiFiLockLocations

SaveWiFiLockDevice in Total Connect. Equivalent SOAP API : SaveWiFiLockDevice

Return a list of TCC WiFi locations and devices. Equivalent SOAP API : GetWiFiThermostatLocations

No documentation available.

Returns Success on Token Generation. Equivalent SOAP API : GenerateThermostatAccessToken

To Add/Delete the TCC WiFi Thermostats in Total Connect. Equivalent SOAP API : AddDeleteWiFiThermostats

To Add/Delete the WiFi Thermostats in Total Connect. Equivalent SOAP API : AddDeleteWiFiThermostats

Activate and Remove Lyric Thermostat in Total Connect. Equivalent SOAP API: AddRemoveLyricThermostat

Activate and Remove Lyric Thermostat in Total Connect. Equivalent SOAP API: AddRemoveLyricThermostat

Get All users. TC2-16214 -[Improvement] User List - REST API - Multiple Input filters request LocationID > 0 ---- All Users on this Location or = 0 ----All Users in all Location AdminUserFilter = 1/NULL ---- It's returned "Admin User" list. or = False ---- It's not returned "Admin User" list StandUserFilter = 1/NULL ---- It's returned "Stand User" list. or = False ---- It's not returned "Stand User" list PanelOnlyUserFilter = 1/NULL ---- It's returned "PanelOnly User" list. or = False ---- It's not returned "PanelOnly User" list. PartitionManagerUserFilter = 1 ---- It's returned "PartitionManager User" list. or = 0 ---- It's returned "Non PartitionManager User" list or = NULL---- - both. OutOfSyncFilter = 1 ---- Out of sync users list or = 0 ---- Non Out of sync users list or = NULL---- - both DuplicateUserCodeFilter = 1 ---- Duplicate UserCode users list or = 0---- Non Duplicate UserCode users list or = NULL ----- both UserEnabledFilter = 1---- Enabled user list or = 0 ---- Non Enabled user list or = NULL---- - both UserValidatedFilter = 1 ---- Email validated users list or = 0---- Non Email validated users list or = NULL ----- both PartitionIDs varchar(100) = null --- Non Partition users list or = '1,2'-- - Spec.Paratition access users list

Return List of Home card devices.

[TC3.24+] Replacement for SaveUserEx1. Included Partition informations

[TC2.1+] R Get User information with Partition Authority

Request for PanelMetadata and security status of each partition for the Given Location and User.

No documentation available.

[TC3.24 +] Replacement for GetAllUserDetailsEx. It will return user partition related informations: UserId -1 and usertypeid 2 will give you the template for user creation

Get All users Input Filter Values Info. 0 -- Renote Login Users on all locations -1 -- Panel Only Users on all locations -2 -- All users on all locations -3 -- Users out of sync on all locations

This method get for current user logged info.

Return List of Partitions Authority Level info.

[TC2.1+] R Get User information with Partition Authority

Return Preferred List of Location for Home Card.

Return List of Home card devices.

Return List of Duplicate User Info

Return user authorized for onboarding partitions and partition configuration.

Request for PanelMetadata and security status of each partition for the Given Location and User.

Request for PanelMetadata and security status of each partition for the Given Location and User.

[TC2.2+] Provides list of Notification Methods Equivalent SOAP API : GetNotificationMethods

[TC2.1+] Provides list of SMS Email Carriers Equivalent SOAP API : GetSMSEmailCarriers

Return List of Home card devices.

[TC3.24+] Replacement for SaveUserEx1. Included Partition informations

TC2.3+ Disable / Enable multiple users

Update user prefered HomeCard order

Update user prefered HomeCard order. "Please Ignore Status parameter for POST method, that parameter only required for GET method"

Save Homecard Devices

Return true if user code available

Returns list of locations having the given usercode

No documentation available.

Need to be able to select multiple users from the user list page and apply Partition Manager role. The role will apply only to admin users. The role will apply to all multi-partitions locations to which the user has access. The role can be applied before partitions is activated for a location.

[TC2.1+] Synchronize Total Connect Users with Security System user codes Equivalent SOAP API: SynchronizePanelUser

[TC3.12+] Used to get feedback from users Equivalent SOAP API : SubmitUserFeedback

[TC3.12+] Used to get feedback from users along with EmailID and rating Equivalent SOAP API : SubmitUserFeedback_V1

TC3+ Update Privacy Concern for User

To find List of Duplicate User Info

This method should be called in the scenario user enters his validation key in TC2 application for email validation. Validation key will be sent through an email Equivalent SOAP API : ValidateEmailAddressInSession

[TC3.8+] Created for Save MasterUsercode in TC if MasterUsercode changed in the panel. Equivalent SOAP API : SaveMasterUserCode

Used to update the user password after login, so sessioid, OldPassword and NewPassword is must Equivalent SOAP API : UpdateUserPassword

Used to update the user password after login, so sessioid, userName and NewPassword is must Equivalent SOAP API : ResetUserPassword

Used to update only the Language (LocaleId value) for a User. Country Code (ex. en-US) or a language Id as defined within TC2 can be used to update the value in the User Table. Equivalent SOAP API : UpdateUserLanguage

Save User-Client Preferences Equivalent SOAP API : SaveUserClientPreferences

Update Eula or SMS Eula for a User Equivalent SOAP API :UpdateEula

[TC2.1+] Replacement for DeleteUserInfo. Deletes a Real User or Marks Virtual user for Deletion Equivalent SOAP API :DeleteUser

Returns a set of device or audit event records. A maximum of 100 records can be returned per call.Eevnts by partition (This method is used HttpPost action. Reason: "EventFilters" input model pass more inbound params.)

Get the Alexa Smart home details

No documentation available.

No documentation available.

No documentation available.

After the alarm occurs in TC user have option to confirm the Alarm or Cancel it.

User can generate remote panic alrm from this API.

Get the Partnerinformation for the spec. location.

Get the RTSP live stream url for given camera

Revoke access token and refresh token for chamberlain garage door

Get the list of garage door devices

Return a Activation status for Lyric Camera. Equivalent SOAP API : GetPartnerCameraActivationStatus

Return Lyric Camera and RSI Camera status. Equivalent SOAP API : GetCameraStatus

Return a Settings for Lyric Camera. Equivalent SOAP API : GetPartnerCameraLiveStream

Return Live Stream detail for Partner Camera Equivalent SOAP API : GetPartnerCameraLiveStream

Generate August Access Token by using Access code for particular Location

Generate access token for chamberlain garage door

Generate access token for chamberlain garage door

Log Message to Kibana Server

Return Enrollment details for a Partner Camera Equivalent SOAP API : EnrollPartnerCamera

Fix TC2-24107 Return Enrollment details for a Partner Camera Equivalent SOAP API : EnrollPartnerCamera

Return Live Snapshot detail for Partner Camera Equivalent SOAP API : RequestPartnerCameraSnapshot

Return Live Stream detail for Partner Camera

Save the Settings for Lyric Camera. Equivalent SOAP API : SavePartnerCameraSettings

Save the privacy Settings for Lyric Camera. Equivalent SOAP API : SavePartnerCameraPrivacySettings

Remove Lyric Camera from the Location. Equivalent SOAP API : RemovePartnerCamera

Return Lyric Camera and RSI Camera status. Equivalent SOAP API : GetCameraStatus

Return a Settings for Lyric Camera. Equivalent SOAP API : GetPartnerCameraLiveStream

This Api returns the TMS Snapshot token

To Get the Smart Action/Scene List: REST STANDARD

To List the Smart Action/Scene: SOAP Result Data

To Run a specific scene/action: SOAP Result Data

To Get the Smart Action/Scene Configuration

To add or Edit the Smart Action

To add or Edit the Scenes

To Retrieve the Smart Action information

To Set the Smart Action state Equivalent SOAP API : SetSmartActionState

To add or Edit the SmartAction or SmartScene

To Remove the List of Smart Actions/Scenes

No documentation available.

No documentation available.

This API is used to checking for unacknowledged awareness events

This API is used to update the viewed state of awareness event (viewed)

This API is used to acknowledge the awareness events

Get the list of notification states permitted for this location.

Get the Event Metadata applicable for the Given Location. Used for Notification Configuration Equivalent SOAP API: GetEventMetaDataEx

Get the Event Metadata applicable for the Given Location based on Partitions. Used for Notification Configuration Equivalent SOAP API: GetEventMetaDataExV2

Get Configured Notification Events at the Given Location. Equivalent SOAP API: GetConfiguredEvents

Get Configured Notification Events at the Given Location.Added notification flags for each module Equivalent SOAP API: GetConfiguredEventsEx

Get Summary of Configured Notification Events in XML at the Given Location. Equivalent SOAP API: GetEventSummaryXML

Get Summary of Configured Notification Events at the Given Location. Equivalent SOAP API: GetEventSummary

Get the list of notification states permitted for this location. Equivalent SOAP API: GetAllNotificationConditionalStates

Get the list of notification schedules available. Equivalent SOAP API: GetAllNotificationSchedules

Retrieves the Notification Lists associated with current user's TotalConnect account

Retrieves the Notification Lists associated with current user's TotalConnect account based on eventItemID

Update the stored data for the list of event notifications for the given location

Inserts or updates the user's mobile device token for push notifications. Equivalent SOAP API: InsertUserMobileDeviceToken

Update User's Push notification Subscription Equivalent SOAP API: UpdatePushSubscription

Sends Summary Email about the Notification List to the Admin user Equivalent SOAP API: SendTestNotification

Add new notification for edimax this location.

Add new event notification for this location.

Enable/disabled notifications for logged in user and/or return notification pause status.

Pause / Allow all notifications for logged in user

Retrieve the current configuration information for the given Video PIR.

Retrieve the list of Video PIR for the specified session and location.

Get the capturetypes for VideoPIR device

Returns the Video PIR event record based on Event TypeID

Trigger the Peek In Now Action for VideoPIR.

Update the configuration information for the given VideoPIR. Since the method consists of more params, it is implemented as POST Method

To get the list of All EULA's before login to be viewed by the user. : GetPreLoginEulaInfo

To get the EULA Text for the given language id and eula id.: GetPreLoginEulaText

No documentation available.

No documentation available.

No documentation available.

Get the RTSP live stream url for given camera

No documentation available.

No documentation available.

No documentation available.

No documentation available.

Request session details for the given sessionID

The Logout method is provided to forcefully terminate an active session in the system. Clients should make an effort to encourage the users to use the Logout feature if at all possible. Request that the given sessionID be logged out and/or terminated.

Request session details for the given sessionID

Request for Static Key information for Clients

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

The Logout method is provided to forcefully terminate an active session in the system. Clients should make an effort to encourage the users to use the Logout feature if at all possible. Request that the given sessionID be logged out and/or terminated.

This method should be called in the scenario user enters his validation key in TC2 application for email validation. Validation key will be sent through an email Equivalent SOAP API: ValidateEmailAddressInSession

This can be called in the scenario user clicks on the Email Validation link sent through an email. Equivalent SOAP API: ValidateNewEmailAddress

This can be called in the scenario user clicks on the 'Unsubscribe' link in marketting e-mails.

This will be called in the scenario user clicks on the Validation button next to the Email address Equivalent SOAP API: SendEmailValidationDetails

This will be called in the scenario user clicks on the Validation button next to the Email address Used to send an validation link to the multiple users Equivalent SOAP API: SendMultipleEmailValidationDetails

This can be called in the scenario user clicks on the Email Validation link sent through an email. user will be asked for his usename to avoid typing mistakes happening while recording the email address Equivalent SOAP API: ValidateEmailAddress

To Get Camera status

Get Camera Configuration Details

Return Enrollement status for a Partner Camera Equivalent SOAP API : InsertUpdatePartnerCamera

Return Configuration Update status for a Partner Camera

Set value for Thermostat.

Control the carrier thermostat

Set Lock/Unlock for multiple Locks.

On/Off - Specific or Multiple switchs.

Returns the data associated with a Location object from the database EQUIVALENT SOAP API : GetLocation by location ID

Get location all camera list Equivalent SOAP API : GetLocationAllCameraListEx

Get all automation devices - Includes switch, lock and Thermostats.

Get All Automation Swithes

Get Specific Switch

Get all automation locks.

Get specific lock.

Get all automation thermostats.

Get specific Thermostat.

Get a Thermostat schedule (from database) Equivalent SOAP API : GetThermostatSchedule

Get all the Thermostats and Locks info by given List of Locations

Control MultiFamily Bulk thermostat

Update a Switch Icon (database only) Equivalent SOAP API : UpdateSwitchIcon

Update a Thermostat schedule (database only) Equivalent SOAP API : UpdateThermostatSchedule

Setting Schedule Status for a thirdparty thermostat

Control the carrier thermostat

Execute Security Panel and Automation Synchronization

On/Off - Specific or Multiple switchs.

Set Lock/Unlock for multiple Locks.

Set value for Thermostat.

Returns the Current Status of all the services enrolled