WS Binding: UDIServices_Binding

Port type UDIServices_PortTypeSource code

1. AddDDNSHost
   Source code
   Description:
   Registers and DDNS host with the associated IP
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   AddDDNSHostRequest (soap:body, use = literal)Source code
   AddDDNSHost type AddDDNSHost

   • host type string
   • ip type string
   Output:
   DefaultResponseMessage (soap:body, use = literal)Source code
   UDIDefaultResponse type UDIDefaultResponse

   • status type string
   • info - optional; type string
2. AddFolder
   Source code
   Description:
   Adds a folder
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   AddFolderRequest (soap:body, use = literal)Source code
   AddFolder type AddFolder

   • id type string

   • name type string
   Output:
   DefaultResponseMessage (soap:body, use = literal)Source code
   UDIDefaultResponse type UDIDefaultResponse

   • status type string
   • info - optional; type string
3. AddGroup
   Source code
   Description:
   Adds a scene/group
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   AddGroupRequest (soap:body, use = literal)Source code
   AddGroup type AddGroup

   • id type string

   • name type string

   • flag type NodeTypeFlag - type byte with restriction - enum { '1', '4', '8' }
   Output:
   DefaultResponseMessage (soap:body, use = literal)Source code
   UDIDefaultResponse type UDIDefaultResponse

   • status type string
   • info - optional; type string
4. AddNode
   Source code
   Description:
   Adds a predefined node for a device with a given address
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   AddNodeRequest (soap:body, use = literal)Source code
   AddNode type AddNode

   • id type string

   • name type string

   • type type string
   • flag type NodeOperationsFlag - type byte with restriction - enum { '1', '2', '3', '4' }
   Output:
   DefaultResponseMessage (soap:body, use = literal)Source code
   UDIDefaultResponse type UDIDefaultResponse

   • status type string
   • info - optional; type string
5. ClearLastError
   Source code
   Description:
   Clears the list of recent errors in ISY
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   ClearLastErrorRequest (soap:body, use = literal)Source code
   ClearLastError type ClearLastError
   Output:
   DefaultResponseMessage (soap:body, use = literal)Source code
   UDIDefaultResponse type UDIDefaultResponse

   • status type string
   • info - optional; type string
6. GetCurrentSystemStatus
   Source code
   Description:
   Sends the current system status (whole) to the given subscriber
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   GetCurrentSystemStatusRequest (soap:body, use = literal)Source code
   GetCurrentSystemStatus type GetCurrentSystemStatus

   • SID type string
   Output:
   DefaultResponseMessage (soap:body, use = literal)Source code
   UDIDefaultResponse type UDIDefaultResponse

   • status type string
   • info - optional; type string
7. GetDDNSHost
   Source code
   Description:
   Returns the currently configured DDNS host
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   GetDDNSHostRequest (soap:body, use = literal)Source code
   GetDDNSHost type GetDDNSHost
   Output:
   GetDDNSHostResponse (soap:body, use = literal)Source code
   DDNSHost type DDNSHost

   DDNS host object. The name is mandatory.

   • name type string
   • ip - optional; type string
8. GetDebugLevel
   Source code
   Description:
   Gets the debug options and current level
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   GetDebugLevelRequest (soap:body, use = literal)Source code
   GetDebugLevel type GetDebugLevel
   Output:
   GetDebugLevelResponse (soap:body, use = literal)Source code
   DBG type DBG

   Debug structure

   • options type DebugOptions
     The possible debug levels that can be chosen
     • option - unbounded; type string
   • current type string
9. GetISYConfig
   Source code
   Description:
   Returns the current configuration of ISY
   Style:
   document
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   GetISYConfigRequest (soap:body, use = literal)Source code
   GetISYConfig type GetISYConfig
   Output:
   GetISYConfigResponse (soap:body, use = literal)Source code
   configuration type configuration

   • deviceSpecs type DeviceSpecifications
     Describes the characteristics of the ISY hardware/firmware and some info about the underlying protocol
     • make - optional; type string
     • manufacturerURL - optional; type string
     • model type string
     • icon - optional; type string
     • archive type string
     • chart type string
     • queryOnInit type boolean
       Whether or not ISY queries all devices upon reboot
     • oneNodeAtATime type boolean
       Whether or not nodes are queried one at a time
   • upnpSpecs type UPnPSpecifications
     • upnpDevice type UPnPInfo
       Provides pertinent information about how ISY will interact with the UPnP subsystem
       • utype type string
         The UPnP device/service type which is advertised and responded to
       • version type string
     • upnpService type UPnPInfo
       • utype type string
         The UPnP device/service type which is advertised and responded to
       • version type string
   • controls - optional; type Controls
     • control - optional, unbounded; type Control
       • name type ControlType
       • label - optional; type string
       • readOnly - optional; type boolean
         default is true
       • isQueryAble - optional; type boolean
         default is false
       • isNumeric - optional; type boolean
       • numericUnit - optional; type string
       • min - optional; type integer
       • max - optional; type integer
       • isGlobal - optional; type boolean
         Applies to ISY as a whole
       • isGUI - optional; type boolean
         It has no correspomding value on the device side
       • actions - optional; type Actions
         • action - optional, unbounded; type Action
           • name type string
           • label type string
           • description - optional; type string
           • readOnly - optional; type boolean
   • driver_timestamp type string
   • app type string
   • app_version type string
   • platform type string
   • build_timestamp type string
   • baseDriver - optional; type ProductDriverType
     Product Drivers are tied into functionality for specific Protocol/Configuration
     • type type string
       The type/name of the driver. e.g. INSTEON
     • version type string
       ISY version for the driver
   • root type DeviceRoot
     Defines the root Group for ISY.
     • id type string
     • name type string
   • product type Product
     Describes the type of ISY for which this is the configuration
     • id type string
     • desc - optional; type string
   • features - optional; type Features
     A list of ISY installed features/services
     • feature - optional, unbounded; type Feature
       An ISY feature or service.
       • id type int
       • desc - optional; type string
       • isInstalled - optional; type boolean
       • isAvailable - optional; type boolean
   • triggers type boolean
     Whether or not Triggers are activated
   • maxTriggers - optional; type integer
     Maximum number of triggers supported for this platform. If not present, assume 1024. Examples: 1024, 2048
   • security - type string with restriction - enum { 'SSL', 'UPNP' }
   • isDefaultCert - optional; type boolean
     Whether or not we are using the default SSL certificate which was shipped originally with ISY
   • internetAccessURL - optional; type string
     The remote/extenal/internet URL by which one can access this system
   • secsys - optional; type SecuritySystemType
     Defines the type of security system(s) configured for ISY
     • type type SupportedSecuritySystems - type string with restriction - enum { 'ELK' }
       Supported Security Systems
     • version type string
       ISY version for the driver
     If a security system has been installed/configured, include the type/version here
10. GetLastError
    Source code
    Description:
    Gets the list of recent errors in ISY
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    GetLastErrorRequest (soap:body, use = literal)Source code
    GetLastError type GetLastError
    Output:
    GetLastErrorResponse (soap:body, use = literal)Source code
    LastError type LastError

    A list of DriverError(s)

    • error - unbounded; type DriverError
      Driver error definitions
      • code type int
      • param1 - optional; type string
      • param2 - optional; type string
11. GetNodesConfig
    Source code
    Description:
    Returns the configuration of nodes, groups, scenes, and any relationship thereto
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    GetNodesConfigRequest (soap:body, use = literal)Source code
    GetNodesConfig type GetNodesConfig
    Output:
    GetNodesConfigResponse (soap:body, use = literal)Source code
    nodes type nodes

    The configuration of all the des already set in ISY

    • root - optional; type string
      The name of ISY network. If blank, then it may be construed as the Network node.
    • folder - optional, unbounded; type folder - extension of abstract type UDNode
      • address type string
        The unique address for a node. This address is the one to be used in subsequent calls to ISY to impact a node/group/scene change
      • name type string
        The user defined name for a device.
      • family - optional; type NodeFamilyID
        This element defines the family of a device. Families are basically the protocol/manufacturer level categories for a device. For instance, RCS is a family and so is INSTEON or UPB. Using this element allows supporting multiple protocols using the same system. In case of a device node, each family may have different device types (such as thermostats vs. load controllers). Family definitions maybe found in [id]_fam.xml. e.g. 1_fam.xml defines INSTEON family whereas 3_fam.xml defines RCS
      • parent - optional; type NodeParent
        • type type NodeHierarchyFlag - type byte with restriction - enum { '0', '1', '2', '3' }
          The hierarchy type for the parent
        The address of the parent if any
      • flag - required; type short
        A bit mask: 0x01 -- Node is initialized (internal) 0x02 -- Node is going to be crawled (internal) 0x04 -- This is a group node 0x08 -- This is the root node for ISY, i.e. My Lighting 0x10 -- Device Communications Error 0x20 -- Brand new node 0x40 -- Node shall be deleted 0x80 -- Node is device root
      Signifies a folder. Note that folders do not have ELK-IDs
    • node - optional, unbounded; type node - extension of abstract type UDNode
      • address type string
        The unique address for a node. This address is the one to be used in subsequent calls to ISY to impact a node/group/scene change
      • name type string
        The user defined name for a device.
      • family - optional; type NodeFamilyID
        This element defines the family of a device. Families are basically the protocol/manufacturer level categories for a device. For instance, RCS is a family and so is INSTEON or UPB. Using this element allows supporting multiple protocols using the same system. In case of a device node, each family may have different device types (such as thermostats vs. load controllers). Family definitions maybe found in [id]_fam.xml. e.g. 1_fam.xml defines INSTEON family whereas 3_fam.xml defines RCS
      • parent - optional; type NodeParent
        • type type NodeHierarchyFlag - type byte with restriction - enum { '0', '1', '2', '3' }
          The hierarchy type for the parent
        The address of the parent if any
      • flag - required; type short
        A bit mask: 0x01 -- Node is initialized (internal) 0x02 -- Node is going to be crawled (internal) 0x04 -- This is a group node 0x08 -- This is the root node for ISY, i.e. My Lighting 0x10 -- Device Communications Error 0x20 -- Brand new node 0x40 -- Node shall be deleted 0x80 -- Node is device root
      • type type string
        The type of device. For INSTEON: device-cat.device-subcat.version.reserved (4 bytes) Please note that the if family element is present, then the device type is a category/sub category within the family. In most cases the device cat/subcat for all families are the same
      • enabled - optional; type boolean
        Whether or not the node is enabled (plugged in). Note: this feature only works on 99 Series
      • deviceClass - optional; type DeviceClass
        Type of device which may give a hint as to how to duty cycle
      • wattage - optional; type int
        Approximate wattage for this device in watts
      • dcPeriod - optional; type int
        Duty cycle period in minutes
      • pnode - optional; type string
        The address of the primary node for the device partially represented by this node. If this node is the primary node then pnode will equal address. A device may be represented by one or more nodes. One of these nodes is designated the primary node and is used to help group the set of nodes for a device. Note: UPB Mandatory/INSTEON Optional.
      • sgid - optional; type string
        The ID identifying the subgroup of end-points for the device. Each node representing a subset of the end-points for a device is identified by a unique subgroup ID. This is similar in function to the last digit in an Insteon Node Address. Note: UPB Mandatory/INSTEON Optional.
      • qry - optional; type Empty
        Whether or not a node is queryable. If this tag is not present, then node is not queryable. A tag was used for future extensibility. Note: Currently UPB Only.
      • ctl - optional; type Empty
        Whether or not a node may be used as a controller. If this tag is not present, then node is may not be used as a controller. A tag was used for future extensibility. Note: Currently UPB Only.
      • tx - optional; type unsignedInt
        Bitmask indicating the controller endpoints represented by this node. A tag was used for future extensibility. Note: Currently UPB Only.
      • rx - optional; type unsignedInt
        Bitmask indicating the responder endpoints represented by this node. A tag was used for future extensibility. Note: Currently UPB Only.
      • rsp - optional; type ResponderType
        • type - required; type ResponderTypes
        If present, then this node may be used as a scene responder. The type of responder is defined in the type attribute. Note: Currently, UPB Only (see upb.xsd)
      • ELK_ID - optional; type string
        ELK unique identifier for each node/scene/group
    • group - optional, unbounded; type group - extension of abstract type UDNode
      • address type string
        The unique address for a node. This address is the one to be used in subsequent calls to ISY to impact a node/group/scene change
      • name type string
        The user defined name for a device.
      • family - optional; type NodeFamilyID
        This element defines the family of a device. Families are basically the protocol/manufacturer level categories for a device. For instance, RCS is a family and so is INSTEON or UPB. Using this element allows supporting multiple protocols using the same system. In case of a device node, each family may have different device types (such as thermostats vs. load controllers). Family definitions maybe found in [id]_fam.xml. e.g. 1_fam.xml defines INSTEON family whereas 3_fam.xml defines RCS
      • parent - optional; type NodeParent
        • type type NodeHierarchyFlag - type byte with restriction - enum { '0', '1', '2', '3' }
          The hierarchy type for the parent
        The address of the parent if any
      • flag - required; type short
        A bit mask: 0x01 -- Node is initialized (internal) 0x02 -- Node is going to be crawled (internal) 0x04 -- This is a group node 0x08 -- This is the root node for ISY, i.e. My Lighting 0x10 -- Device Communications Error 0x20 -- Brand new node 0x40 -- Node shall be deleted 0x80 -- Node is device root
      • deviceGroup - optional; type string
        The underlying group/scene number associated with this scene. Normally, not used except for programs made for debugging
      • ELK_ID - optional; type string
        ELK unique identifier for each node/scene/group
      • members - optional; type UDLinkMembers
        • link - unbounded; type UDLink
          • type type short
            0x00 -- Node is neither a controller or responder for the enclosing scene. i.e. devices under the My Lighting node 0x10 -- Node is a controller for the enclosing scene 0x20 -- Node is a responder for the enclosing scene
          The unique address for a node.
        The address and the type (controller vs. responder) of devices participating in a group/scene
12. GetSMTPConfig
    Source code
    Description:
    Returns the SMTP Options configured in ISY
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    GetSMTPConfigRequest (soap:body, use = literal)Source code
    GetSMTPConfig type GetSMTPConfig
    Output:
    GetSMTPConfigResponse (soap:body, use = literal)Source code
    SMTPConfig type SMTPConfig

    SMTP Configuration UseDefaultSMTP = Whether or not we should use UDI's default SMTP Server SMTPServer = SMTP Server SMTPPort = SMTP Port SMTPUID = SMTP User ID SMTPPWD = SMTP Password SMTPFrom = SMTP From email address SMTPTimeout = SMTP Timeout to wait for each operation UseTLS = Whether or not we should use TLS

    • UseDefaultSMTP - optional; type boolean
    • SMTPServer type string
    • SMTPPort type int
    • SMTPUID - optional; type string
    • SMTPPWD - optional; type string
    • SMTPFrom - optional; type string
    • SMTPTimeout - optional; type int
    • UseTLS - optional; type boolean
13. GetSceneProfiles
    Source code
    Description:
    Gets the profile attributes for responders. Set the controller element to scene's address and: In case this is an ISY scene, set the node element to "none." In case this is a controller for a scene, set the node element to the controller's address
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    GetSceneProfilesRequest (soap:body, use = literal)Source code
    GetSceneProfiles type GetSceneProfiles

    • node type string
    • controller type string
    Output:
    GetSceneProfilesResponse (soap:body, use = literal)Source code
    SceneProfiles type SceneProfiles

    The structure which represents the profiles of responders for a scene

    • SP - optional, unbounded; type SceneProfile
      The structure which represents the profile of responders for a scene OL = on level RR = ramp rate Climate will be added in release 3
      • node type string
      • OL - optional; type double
      • RR - optional; type double
      • CLISPC - optional; type double
      • CLISPH - optional; type double
      • CLIFS - optional; type int
      • CLIMD - optional; type int
14. GetStartupTime
    Source code
    Description:
    Returns a timestamp of when ISY was last started
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    GetStartupTimeRequest (soap:body, use = literal)Source code
    GetStartupTime type GetStartupTime
    Output:
    TimeResponseMessage (soap:body, use = literal)Source code
    UDITimeResponse type UDITimeResponse

    • val - required; type dateTime
      Timestamp in the form of YYYYMMDD HH:MM:SS
15. GetSystemDateTime
    Source code
    Description:
    Returns the current state of ISY
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    GetDateTimeRequest (soap:body, use = literal)Source code
    GetSystemTime type GetSystemTime
    Output:
    GetDateTimeResponse (soap:body, use = literal)Source code
    DT type DT

    ISY's DateTime Structure: NTP = time in NTP format TMZOffset = Time zone Offset from GMT (in seconds) DST = Daylight Saving Time (true/false) Lat = Latitude (in degrees) Long = Longitude (in degrees) Sunrise = Sunrise time in NTP format (response only) Sunset = Sunset time in NTP format (response only) IsMilitary = Whether or not we should use 24 hour format

    • NTP type long
    • TMZOffset type int
    • DST type boolean
    • Lat type float
    • Long type float
    • Sunrise - optional; type long
    • Sunset - optional; type long
    • IsMilitary - optional; type boolean
16. GetSystemOptions
    Source code
    Description:
    Returns the options by which ISY is configured
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    GetSystemOptionsRequest (soap:body, use = literal)Source code
    GetSystemOptions type GetSystemOptions
    Output:
    GetSystemOptionsResponse (soap:body, use = literal)Source code
    SystemOptions type SystemOptions

    ISY's System Options (configuration of how ISY works) MailTo = Comma delimited list of notification recipients CompactEmail = Whether or not to send short notifications QueryOnInit = Whether or not to query all devices at Restart PCacthUp = Whether or not programs should catch up upon startup PGracePeriod = The amount of time (in seconds) after which a schedule is still considered met NTPHost = NTP host name NTPActive = Whether or not ISY has been able to communicate with the NTP host NTPEnabled = Whether or not NTP checking is enabled NTPInterval = The amount of time (in seconds) between each NTP check WaitBusyReading = Whether or not ISY has to wait for "silence" before sending the next packet HTMLRole = The role of the HTML user

    • MailTo type string
    • CompactEmail type boolean
    • QueryOnInit type boolean
    • PCatchUp type boolean
    • PGracePeriod type int
    • NTPHost type string
    • NTPActive type boolean
    • NTPEnabled type boolean
    • NTPInterval type int
    • WaitBusyReading type boolean
    • HTMLRole type HTMLRoleFlag - type integer with restriction - enum { '1', '2', '3', '4' }
17. GetSystemStatus
    Source code
    Description:
    Returns the current state of ISY
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    GetSystemStatusRequest (soap:body, use = literal)Source code
    GetSystemStatus type GetSystemStatus
    Output:
    GetSystemStatusResponse (soap:body, use = literal)Source code
    SysStat type SysStat

    ISY's System Status: NumRemainingOps = an estimate of how many operations are left to complete DelayBetweenOps (in miliseconds) = an estimate of any delay between each operation Note: you may assume 1 second per each operation

    • Stat type ISYStatusFlag - type byte with restriction - enum { '0', '1', '2', '3', '10' }
    • NumRemainingOps type long
    • DelayBetweenOps type long
    • InSafeMode type boolean
18. GetVariable
    Source code
    Description:
    Retrieves a variable
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    GetVariableRequest (soap:body, use = literal)Source code
    GetVariable type GetVariable

    Parameter for retrieving the value of a specific variable

    • type type UDIVariableType - type string with restriction - enum { '1', '2' }
    • id type string
    Output:
    GetVariableResponse (soap:body, use = literal)Source code
    var type var

    Defines a variable
    • init type string
      Initial value of a variable
    • val type string
    • ts type string
      The last updated time stamp in YYYYMMDD HH:MM:SS
    • type - required; type UDIVariableType - type string with restriction - enum { '1', '2' }
    • id - required; type string
      The id of the variable
19. GetVariables
    Source code
    Description:
    Retrieves all variables of a certain type
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    GetVariablesRequest (soap:body, use = literal)Source code
    GetVariables type GetVariables

    Parameter for retrieving all variables of a certain type

    • type type UDIVariableType - type string with restriction - enum { '1', '2' }
    Output:
    GetVariablesResponse (soap:body, use = literal)Source code
    vars type vars

    list of variables

    • var - optional, unbounded; type Variable
      Defines a variable
      • init type string
        Initial value of a variable
      • val type string
      • ts type string
        The last updated time stamp in YYYYMMDD HH:MM:SS
      • type - required; type UDIVariableType - type string with restriction - enum { '1', '2' }
      • id - required; type string
        The id of the variable
20. InternetAccess
    Source code
    Description:
    Enables/Disables port forwarding to ISY on UPnP enabled routers. This process might take a long time and, as such, one must take caution with TCP connect timeouts
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    InternetAccessRequest (soap:body, use = literal)Source code
    InternetAccess type InternetAccess

    • flag type InternetAccessFlag - type byte with restriction - enum { '24', '38' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
21. IsDDNSHostAvail
    Source code
    Description:
    Whether or not a DDNS Host is available
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    IsDDNSHostAvailRequest (soap:body, use = literal)Source code
    IsDDNSHostAvail type IsDDNSHostAvail

    • host type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
22. IsSubscribed
    Source code
    Description:
    Whether or not the client still holds a subscription to ISY; 0 - Not subscribed 1 - Subscribed
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    IsSubscribedRequest (soap:body, use = literal)Source code
    IsSubscribed type IsSubscribed

    • SID type string
    Output:
    IntResponseMessage (soap:body, use = literal)Source code
    UDIIntResponse type UDIIntResponse

    • val - required; type int
      Return value of type integer. Currently used for IsSubscribed
23. MoveNode
    Source code
    Description:
    Moves a node into a group/scene
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    MoveNodeRequest (soap:body, use = literal)Source code
    MoveNode type MoveNode

    • node type string
    • group type string

    • flag type LinkModeFlag - type byte with restriction - enum { '16', '32' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
24. Query
    Source code
    Description:
    Queries a node, a scene, or even the whole network
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    QueryRequest (soap:body, use = literal)Source code
    QueryAll type QueryAll

    • node type string
    • flag type NodeTypeFlag - type byte with restriction - enum { '1', '4', '8' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
25. Reboot
    Source code
    Description:
    Reboots the system
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RebootRequest (soap:body, use = literal)Source code
    Reboot type Reboot
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
26. RemoveDDNSHost
    Source code
    Description:
    Removes the registered DDNS host. Must use GetDDNSHost
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RemoveDDNSHostRequest (soap:body, use = literal)Source code
    RemoveDDNSHost type RemoveDDNSHost

    DDNS host object. The name is mandatory.

    • name type string
    • ip - optional; type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
27. RemoveFolder
    Source code
    Description:
    Removes a folder (permanently) from configuration
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RemoveFolderRequest (soap:body, use = literal)Source code
    RemoveFolder type RemoveFolder

    • id type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
28. RemoveFromGroup
    Source code
    Description:
    Removes a Node from a Group
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RemoveFromGroupRequest (soap:body, use = literal)Source code
    RemoveFromGroup type RemoveFromGroup

    • node type string
    • group type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
29. RemoveGroup
    Source code
    Description:
    Removes a group (permanently) from configuration
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RemoveGroupRequest (soap:body, use = literal)Source code
    RemoveGroup type RemoveGroup

    • id type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
30. RemoveModem
    Source code
    Description:
    Replaces the modem attached to ISY and reconfigures devices if necessary
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RemoveModemRequest (soap:body, use = literal)Source code
    RemoveModem type RemoveModem
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
31. RemoveNode
    Source code
    Description:
    Removes a node (permanently) from configuration
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RemoveNodeRequest (soap:body, use = literal)Source code
    RemoveNode type RemoveNode

    • id type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
32. RenameFolder
    Source code
    Description:
    Renames a folder in configuration
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RenameFolderRequest (soap:body, use = literal)Source code
    RenameFolder type RenameFolder

    • id type string

    • name type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
33. RenameGroup
    Source code
    Description:
    Renames a group in configuration
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RenameGroupRequest (soap:body, use = literal)Source code
    RenameGroup type RenameGroup

    • id type string

    • name type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
34. RenameNetwork
    Source code
    Description:
    Renames the Network name
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RenameNetworkRequest (soap:body, use = literal)Source code
    RenameNetwork type RenameNetwork

    • name type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
35. RenameNode
    Source code
    Description:
    Renames a node in configuration
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RenameNodeRequest (soap:body, use = literal)Source code
    RenameNode type RenameNode

    • id type string

    • name type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
36. ReplaceDevice
    Source code
    Description:
    Replaces one device with another (swap)
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    ReplaceDeviceRequest (soap:body, use = literal)Source code
    ReplaceDevice type ReplaceDevice

    • node type string
    • NewNode type string
    • firmware type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
37. ReplaceModem
    Source code
    Description:
    Replaces the modem attached to ISY and reconfigures devices if necessary
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    ReplaceModemRequest (soap:body, use = literal)Source code
    ReplaceModem type ReplaceModem
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
38. RestoreDevice
    Source code
    Description:
    Restores a specific device from the configuration in ISY
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RestoreDeviceRequest (soap:body, use = literal)Source code
    RestoreDeviceFromNode type RestoreDeviceFromNode

    • node type string
    • flag type RestoreDevicesFlag - type byte with restriction - enum { '0', '1' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
39. RestoreDevices
    Source code
    Description:
    Restores devices from the configuration in ISY
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    RestoreDevicesRequest (soap:body, use = literal)Source code
    RestoreDevicesFromNodes type RestoreDevicesFromNodes

    • flag type RestoreDevicesFlag - type byte with restriction - enum { '0', '1' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
40. SecuritySystemAction
    Source code
    Description:
    Arm/disarm a security system
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SecuritySystemActionRequest (soap:body, use = literal)Source code
    SecuritySystemRequest type SecuritySystemRequest

    Provide the command to be processed in the SecAction tag for example, see ELKActionCodes Provide the security code in the code tag

    • SecAction type string
    • code type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
41. SendHeartbeat
    Source code
    Description:
    Immediately sends a heartbeat message to all subscribers
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SendHeartbeatRequest (soap:body, use = literal)Source code
    SendHeartbeat type SendHeartbeat
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
42. SendTestEmail
    Source code
    Description:
    Sends a test email. This is used to check SMTP settings.
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SendTestEmailRequest (soap:body, use = literal)Source code
    SendTestEmail type SendTestEmail

    • id type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
43. SetBatchMode
    Source code
    Description:
    Causes the system to go to/exit batch mode
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetBatchModeRequest (soap:body, use = literal)Source code
    SetBatchMode type SetBatchMode

    • flag type BatchModeFlag - type integer with restriction - enum { '0', '1' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
44. SetBatteryDeviceWriteMode
    Source code
    Description:
    Enables/disables writing to battery devices automatically
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetBatteryDeviceWriteModeRequest (soap:body, use = literal)Source code
    SetBatteryDeviceWriteMode type SetBatteryDeviceWriteMode

    • flag type BatteryDeviceWriteFlag - type integer with restriction - enum { '0', '1' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
45. SetDebugLevel
    Source code
    Description:
    Sets the debug level (from 1 to 3)
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetDebugLevelRequest (soap:body, use = literal)Source code
    SetDebugLevel type SetDebugLevel

    • option type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
46. SetLinkingMode
    Source code
    Description:
    Changes the way ISY discovers nodes/devices ISY as a controller or ISY as a responder
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetLinkingModeRequest (soap:body, use = literal)Source code
    SetDeviceLinkMode type SetDeviceLinkMode

    • flag type LinkModeFlag - type byte with restriction - enum { '16', '32' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
47. SetNTPOptions
    Source code
    Description:
    Sets NTP Options
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetNTPOptionsRequest (soap:body, use = literal)Source code
    SetNTPOptions type SetNTPOptions

    NTPHost = NTP host name NTPEnabled = Whether or not NTP checking is enabled NTPInterval = The amount of time (in seconds) between each NTP check

    • NTPHost type string
    • NTPEnabled type boolean
    • NTPInterval type int
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
48. SetNodeEnabled
    Source code
    Description:
    Enables or disables a node
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetNodeEnabledRequest (soap:body, use = literal)Source code
    SetNodeEnabled type SetNodeEnabled

    • node type string
    • flag type SetNodeEnabledFlag - type byte with restriction - enum { '0', '1' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
49. SetNodePowerInfo
    Source code
    Description:
    Sets the Power characteristics for a node
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetNodePowerInfoRequest (soap:body, use = literal)Source code
    SetNodePowerInfo type SetNodePowerInfo

    Only available on Orchestrator series

    • node type string
    • deviceClass type DeviceClass
    • wattage - optional; type unsignedInt
    • dcPeriod - optional; type unsignedInt
      The total amount of time, in minutes, which a duty cycle event uses to calculate the amount of time the device should be on/off.
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
50. SetNotificationsOptions
    Source code
    Description:
    Sets Notifications Options
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetNotificationsOptionsRequest (soap:body, use = literal)Source code
    SetNotOptions type SetNotOptions

    MailTo = Comma delimited list of notification recipients CompactEmail = Whether or not to send short notifications

    • MailTo type string
    • CompactEmail type boolean
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
51. SetParent
    Source code
    Description:
    Sets a parent for a node
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetParentRequest (soap:body, use = literal)Source code
    SetParent type SetParent

    • node type string
    • nodeType type NodeHierarchyFlag - type byte with restriction - enum { '0', '1', '2', '3' }
    • parent - optional; type string
    • parentType - optional; type NodeHierarchyFlag - type byte with restriction - enum { '0', '1', '2', '3' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
52. SetProgramOptions
    Source code
    Description:
    Sets Program Options
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetProgramOptionsRequest (soap:body, use = literal)Source code
    SetProgramOptions type SetProgramOptions

    PCacthUp = Whether or not programs should catch up upon startup PGracePeriod = The amount of time (in seconds) after which a schedule is still considered met HTMLRole = The role for HTML user

    • PCatchUp type boolean
    • PGracePeriod type int
    • HTMLRole type HTMLRoleFlag - type integer with restriction - enum { '1', '2', '3', '4' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
53. SetSMTPConfig
    Source code
    Description:
    Sets SMTP Configuration Parameters
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetSMTPConfigRequest (soap:body, use = literal)Source code
    SetSMTPConfig type SetSMTPConfig

    SMTP Configuration UseDefaultSMTP = Whether or not we should use UDI's default SMTP Server SMTPServer = SMTP Server SMTPPort = SMTP Port SMTPUID = SMTP User ID SMTPPWD = SMTP Password SMTPFrom = SMTP From email address SMTPTimeout = SMTP Timeout to wait for each operation UseTLS = Whether or not we should use TLS

    • UseDefaultSMTP - optional; type boolean
    • SMTPServer type string
    • SMTPPort type int
    • SMTPUID - optional; type string
    • SMTPPWD - optional; type string
    • SMTPFrom - optional; type string
    • SMTPTimeout - optional; type int
    • UseTLS - optional; type boolean
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
54. SetSceneProfile
    Source code
    Description:
    Sets the profile attribute for responders. Set the controller element to scene's address and: In case this is an ISY scene, set the node element to "none" In case this is a controller for a scene, set the node element to the responder's address
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetSceneProfileRequest (soap:body, use = literal)Source code
    SetSceneProfile type SetSceneProfile

    • node type string
    • controller type string

    • control type ControlType
    • action type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
55. SetSystemDateTime
    Source code
    Description:
    Returns the current state of ISY
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetDateTimeRequest (soap:body, use = literal)Source code
    SetSystemTime type SetSystemTime

    ISY's DateTime Structure: NTP = time in NTP format TMZOffset = Time zone Offset from GMT (in seconds) DST = Daylight Saving Time (true/false) Lat = Latitude (in degrees) Long = Longitude (in degrees) Sunrise = Sunrise time in NTP format (response only) Sunset = Sunset time in NTP format (response only) IsMilitary = Whether or not we should use 24 hour format

    • NTP type long
    • TMZOffset type int
    • DST type boolean
    • Lat type float
    • Long type float
    • Sunrise - optional; type long
    • Sunset - optional; type long
    • IsMilitary - optional; type boolean
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
56. SetUserCredentials
    Source code
    Description:
    Changes the userid and password for a user
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetUserCredentialsRequest (soap:body, use = literal)Source code
    SetUserCredentials type SetUserCredentials

    • name type string
    • password type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
57. SetVariable
    Source code
    Description:
    Sets a variable to the desired value
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SetVariableRequest (soap:body, use = literal)Source code
    SetVariable type SetVariable

    Parameter for setting a variable to the desired value

    • type type UDIVariableType - type string with restriction - enum { '1', '2' }
    • id type string
    • val type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
58. StartNodesDiscovery
    Source code
    Description:
    Puts ISY in discovery (linking) mode Optionally, provide the type of device to look for
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    StartNodesDiscoveryRequest (soap:body, use = literal)Source code
    DiscoverNodes type DiscoverNodes

    Optionally, provide the type of node to be discovered

    • ntype - optional; type string
      Whether or not
    • flag - optional; type byte
      None
    • family - optional; type string
      Optional family ... from family.xsd.
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
59. StopNodesDiscovery
    Source code
    Description:
    The flag decides the operations (reset, crawl, spider) to be performed after device(s) are discovered
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    StopNodesDiscoveryRequest (soap:body, use = literal)Source code
    CancelNodesDiscovery type CancelNodesDiscovery

    • flag type NodeOperationsFlag - type byte with restriction - enum { '1', '2', '3', '4' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
60. Subscribe
    Source code
    Description:
    reportURL: To reuse the socket, use REUSE_SOCKET as the value duration: use infinite
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SubscribeRequest (soap:body, use = literal)Source code
    Subscribe type Subscribe

    • reportURL type string
    • duration type string
    • SID - optional; type string
    Output:
    SubscribeResponse (soap:body, use = literal)Source code
    SubscriptionResponse type Subscription

    • SID type string
    • duration type string
61. SynchWithNTS
    Source code
    Description:
    Adjusts the clock to NTS
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    SynchWithNTSRequest (soap:body, use = literal)Source code
    SynchWithNTS type SynchWithNTS
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
62. UDIService
    Source code
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    UDIServiceRequest (soap:body, use = literal)Source code
    UDIService type UDIService

    In the case of X10: 1. User "X10" as the control 2. action may be null 3. use house code and unit code in node. The format is: HouseCodeUnitCode (UnitCode may be null)

    • control type ControlType
    • action - optional; type string
    • node type string
    • flag type NodeTypeFlag - type byte with restriction - enum { '1', '4', '8' }
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
63. Unsubscribe
    Source code
    Description:
    Unsubscribe from ISY
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    UnsubscribeRequest (soap:body, use = literal)Source code
    Unsubscribe type Unsubscribe

    • SID type string
    • flag - optional; type int
      flag is optional: 0 (or if not supplied): Return error if not currently subscribed 1 : Do not return an error if not currently subscribed
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string
64. WriteDeviceUpdates
    Source code
    Description:
    Causes device updates to be written to the given node
    Style:
    document
    Operation type:
    Request-response. The endpoint receives a message, and sends a correlated message.
    Input:
    WriteDeviceUpdatesRequest (soap:body, use = literal)Source code
    WriteDeviceUpdates type WriteDeviceUpdates

    • node type string
    Output:
    DefaultResponseMessage (soap:body, use = literal)Source code
    UDIDefaultResponse type UDIDefaultResponse

    • status type string
    • info - optional; type string