getDeviceGroupNames Function for SOAP Web Services
Given a fully-qualified Loftware Enterprise SP folder name, this function returns a list of information about every device group in that folder. The request is not recursive, so device groups within subfolders are not included.
Tip: You can use this function to retrieve a summary of all of the device groups in a particular folder.
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 |
|---|---|---|
|
parentFolderFQN |
string |
The fully-qualified name (FQN) of the folder in your Loftware Enterprise SP environment for which you want to retrieve a summary of device groups |
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 additionalData element for each device group in the folder, and one result element with data about the folder itself.
<pub:getDeviceGroupNamesResponse xmlns:pub="http://published.webservices.loftware.com/">
<return success="[true|false]">
<additionalData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="pub:lwDeviceGroupDto">
<id>...</id>
<name>...</name>
<devices>
<id>...</id>
<name>...</name>
</devices>
<failBack>...</failBack>
<failOverType>...</failOverType>
</additionalData>
<result xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="pub:lwFolderDto">
<id>...</id>
<name>...</name>
<fullyQualifiedName>...</fullyQualifiedName>
</result>
</return>
</pub:getDeviceGroupNamesResponse>
Syntax Tips
Additional information is available about the following items.