getDeviceDetails Function for SOAP Web Services
Given the name of a device, this function returns information about that device.
When you create a SOAP Web Service data service for which the WSDL URL is the Loftware Enterprise SP Services Web Services Description Language (WSDL), an operation envelope template containing this function is one of those available. For more information about using SOAP Web Services in Loftware Enterprise SP, see SOAP API for Web Services Integration.
Important! Content in a SOAP Web Service data service or a Web Service integration is case sensitive. This includes names, attributes, and values.
About the syntax documentation
SOAP Operation Envelope (Request)
When you create a SOAP Web Service data service, the XML of the operation envelope template that you select is displayed as the Envelope parameter. Most operation envelope templates include some elements for which you must replace the value with a value appropriate to your environment. If this operation envelope template has such elements, they are described here.
|
Name |
Type |
Description |
|---|---|---|
|
deviceName |
string |
The name of the device group about which you want to retrieve information. Use only the name for the device, not the fully-qualified name. |
SOAP Response Function
The following is the structure of the Response Function expected as part of a SOAP Response received in response to the preceding type of SOAP Operation Envelope (Request). Any ellipses indicate expected data. For more information, see SOAP API for Web Services Integration.
The response includes one result element with data about the device group.
<pub:getDeviceDetailsResponse xmlns:pub="http://published.webservices.loftware.com/">
<return success="[true|false]">
<result xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="pub:lwDeviceDto">
<id>...</id>
<name>...</name>
<deviceDetails>
<entry>
<key>...</key>
<value>...</value>
</entry>
...
<entry>
<key>...</key>
<value>...</value>
</entry>
</deviceDetails>
<familyName>...</familyName>
<modelName>...</modelName>
<stats>
<status>...</status>
</stats>
</result>
</return>
</pub:getDeviceDetailsResponse>
Syntax Tips
Additional information is available about the following items.