ISY Developers:API:Soap
From Universal Devices, Inc. Wiki
SOAP API calls
ISY_Developers : API : Soap
Contents
- 1 SOAP API calls
- 1.1 AddDDNSHost
- 1.2 AddFolder
- 1.3 AddGroup
- 1.4 AddNode
- 1.5 ClearLastError
- 1.6 GetCurrentSystemStatus
- 1.7 GetDDNSHost
- 1.8 GetDebugLevel
- 1.9 GetISYConfig
- 1.10 GetLastError
- 1.11 GetNodesConfig
- 1.12 GetSMTPConfig
- 1.13 GetSceneProfiles
- 1.14 GetStartupTime
- 1.15 GetSystemDateTime
- 1.16 GetSystemOptions
- 1.17 GetSystemStatus
- 1.18 GetVariable
- 1.19 GetVariables
- 1.20 InternetAccess
- 1.21 IsDDNSHostAvail
- 1.22 IsSubscribed
- 1.23 MoveNode
- 1.24 Query
- 1.25 Reboot
- 1.26 RemoveDDNSHost
- 1.27 RemoveFolder
- 1.28 RemoveFromGroup
- 1.29 RemoveGroup
- 1.30 RemoveModem
- 1.31 RemoveNode
- 1.32 RenameFolder
- 1.33 RenameGroup
- 1.34 RenameNetwork
- 1.35 RenameNode
- 1.36 ReplaceDevice
- 1.37 ReplaceModem
- 1.38 RestoreDevice
- 1.39 RestoreDevices
- 1.40 SecuritySystemAction
- 1.41 SendHeartbeat
- 1.42 SendTestEmail
- 1.43 SetBatchMode
- 1.44 SetBatteryDeviceWriteMode
- 1.45 SetDebugLevel
- 1.46 SetLinkingMode
- 1.47 SetNTPOptions
- 1.48 SetNodeEnabled
- 1.49 SetNodePowerInfo
- 1.50 SetNotificationsOptions
- 1.51 SetParent
- 1.52 SetProgramOptions
- 1.53 SetSMTPConfig
- 1.54 SetSceneProfile
- 1.55 SetSystemDateTime
- 1.56 SetUserCredentials
- 1.57 SetVariable
- 1.58 StartNodesDiscovery
- 1.59 StopNodesDiscovery
- 1.60 Subscribe
- 1.61 SynchWithNTS
- 1.62 Unsubscribe
- 1.63 WriteDeviceUpdates
AddDDNSHost
- Registers and DDNS host with the associated IP
AddDDNSHost (string host, string ip)
AddFolder
- Adds a folder
AddFolder (string id, string name)
AddGroup
- Adds a scene/group
AddGroup (string id, string name, flag)
AddNode
- Adds a predefined node for a device with a given address
AddNode (string id, string name, string type, flag)
ClearLastError
- Clears the list of recent errors in ISY
ClearLastError ()
GetCurrentSystemStatus
- Sends the current system status (whole) to the given subscriber
GetCurrentSystemStatus (string SID)
GetDDNSHost
- Returns the currently configured DDNS host
GetDDNSHost ()
GetDebugLevel
- Gets the debug options and current level
GetDebugLevel ()
GetISYConfig
- Returns the current configuration of ISY
GetISYConfig ()
GetLastError
- Gets the list of recent errors in ISY
GetLastError ()
GetNodesConfig
- Returns the configuration of nodes, groups, scenes, and any
GetNodesConfig ()
GetSMTPConfig
- Returns the SMTP Options configured in ISY
GetSMTPConfig ()
GetSceneProfiles
- Gets the profile attributes for responders. Set the controller
GetSceneProfiles (string node, string controller)
GetStartupTime
- Returns a timestamp of when ISY was last started
GetStartupTime ()
GetSystemDateTime
- Returns the current state of ISY
GetSystemDateTime ()
GetSystemOptions
- Returns the options by which ISY is configured
GetSystemOptions ()
GetSystemStatus
- Returns the current state of ISY
GetSystemStatus ()
GetVariable
- Retrieves a variable
GetVariable (type, string id)
GetVariables
- Retrieves all variables of a certain type
GetVariables (type)
InternetAccess
- Enables/Disables port forwarding to ISY on UPnP enabled routers.
InternetAccess (flag)
IsDDNSHostAvail
- Whether or not a DDNS Host is available
IsDDNSHostAvail (string host)
IsSubscribed
- Whether or not the client still holds a subscription to ISY; 0 -
IsSubscribed (string SID)
MoveNode
- Moves a node into a group/scene
MoveNode (string node, string group, flag)
Query
- Queries a node, a scene, or even the whole network
Query (string node, flag)
Reboot
- Reboots the system
Reboot ()
RemoveDDNSHost
- Removes the registered DDNS host. Must use GetDDNSHost
RemoveDDNSHost (string name, string ip)
RemoveFolder
- Removes a folder (permanently) from configuration
RemoveFolder (string id)
RemoveFromGroup
- Removes a Node from a Group
RemoveFromGroup (string node, string group)
RemoveGroup
- Removes a group (permanently) from configuration
RemoveGroup (string id)
RemoveModem
- Replaces the modem attached to ISY and reconfigures devices if
RemoveModem ()
RemoveNode
- Removes a node (permanently) from configuration
RemoveNode (string id)
RenameFolder
- Renames a folder in configuration
RenameFolder (string id, string name)
RenameGroup
- Renames a group in configuration
RenameGroup (string id, string name)
RenameNetwork
- Renames the Network name
RenameNetwork (string name)
RenameNode
- Renames a node in configuration
RenameNode (string id, string name)
ReplaceDevice
- Replaces one device with another (swap)
ReplaceDevice (string node, string NewNode, string firmware)
ReplaceModem
- Replaces the modem attached to ISY and reconfigures devices if
ReplaceModem ()
RestoreDevice
- Restores a specific device from the configuration in ISY
RestoreDevice (string node, flag)
RestoreDevices
- Restores devices from the configuration in ISY
RestoreDevices (flag)
SecuritySystemAction
- Arm/disarm a security system
SecuritySystemAction (string SecAction, string code)
SendHeartbeat
- Immediately sends a heartbeat message to all subscribers
SendHeartbeat ()
SendTestEmail
- Sends a test email. This is used to check SMTP settings.
SendTestEmail (string id)
SetBatchMode
- Causes the system to go to/exit batch mode
SetBatchMode (flag)
SetBatteryDeviceWriteMode
- Enables/disables writing to battery devices automatically
SetBatteryDeviceWriteMode (flag)
SetDebugLevel
- Gets the debug options and current level
SetDebugLevel (string option)
SetLinkingMode
- Changes the way ISY discovers nodes/devices ISY as a controller or
SetLinkingMode (flag)
SetNTPOptions
- Sets NTP Options
SetNTPOptions (string NTPHost, boolean NTPEnabled, int NTPInterval)
SetNodeEnabled
- Enables or disables a node
SetNodeEnabled (string node, flag)
SetNodePowerInfo
- Sets the Power characteristics for a node
SetNodePowerInfo (string node, deviceClass, unsignedInt wattage, unsignedInt dcPeriod)
SetNotificationsOptions
- Sets Notifications Options
SetNotificationsOptions (string MailTo, boolean CompactEmail)
SetParent
- Sets a parent for a node
SetParent (string node, nodeType, string parent, parentType)
SetProgramOptions
- Sets Program Options
SetProgramOptions (boolean PCatchUp, int PGracePeriod, HTMLRole)
SetSMTPConfig
- Sets SMTP Configuration Parameters
SetSMTPConfig (boolean UseDefaultSMTP, string SMTPServer, int SMTPPort, string SMTPUID, string SMTPPWD, string SMTPFrom, int SMTPTimeout, boolean UseTLS)
SetSceneProfile
- Sets the profile attribute for responders. Set the controller
SetSceneProfile (string node, string controller, control, string action)
SetSystemDateTime
- Returns the current state of ISY
SetSystemDateTime (long NTP, int TMZOffset, boolean DST, float Lat, float Long, long Sunrise, long Sunset, boolean IsMilitary)
SetUserCredentials
- Changes the userid and password for a user
SetUserCredentials (string name, string password)
SetVariable
- Sets a variable to the desired value
SetVariable (type, string id, string val)
StartNodesDiscovery
- Puts ISY in discovery (linking) mode Optionally, provide the type
StartNodesDiscovery (string type)
StopNodesDiscovery
- The flag decides the operations (reset, crawl, spider) to be
StopNodesDiscovery (flag)
Subscribe
- Subscribe to Event Stream reportURL To reuse the socket, use REUSE_SOCKET as the value
Subscribe (string reportURL, string duration, string SID)
SynchWithNTS
- Adjusts the clock to NTS
SynchWithNTS ()
Unsubscribe
- Unsubscribe from ISY
Unsubscribe (string SID, int flag)
WriteDeviceUpdates
- Causes device updates to be written to the given node
WriteDeviceUpdates (string node)
