Element: getDevicesResponse

Description

A getDevicesResponse message contains an element of getDevicesResponseType.

Derived By

Type getDevicesResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
statusInfo	OpsEmbeddedStatusInfoType	1..1	See OpsEmbeddedStatusInfoType.
failedData	failedGetDevicesDataType	0..1	See failedGetDevicesDataType.
responseData	getDevicesResponseDataType	0..1	See getDevicesResponseDataType.

Referenced By

Name	Type
getDevicesQuery	Method

XML Example

The following XML fragments illustrate getDevicesResponse messages:

Sample Successful Response Data:

      <getDevicesResponse>
         <statusInfo>
            <status>SUCCESS</status>
         </statusInfo>
         <responseData>
            <device>
               <deviceIdentifier>
                  <deviceType>CLIENT</deviceType>

                  <deviceId>client1</deviceId>
               </deviceIdentifier>
               <hostTypeName>
                  <name>client</name>
               </hostTypeName>
               <deviceStatus>ACTIVE</deviceStatus>
               <channelPartners>
                  <channelPartner>
                     <tierName>bo.constants.partnertiernames.endcustomer</tierName>
                     <accountUnit>

                        <primaryKeys>
                           <name>s1</name>
                        </primaryKeys>
                     </accountUnit>
                     <contact/>
                     <currentOwner>false</currentOwner>
                  </channelPartner>
               </channelPartners>
               <soldTo>
                  <displayName>Account 1</displayName>

                  <name>s1</name>
               </soldTo>
               <preBuiltProduct>
                  <name>builtIn</name>
                  <version>1.0</version>
               </preBuiltProduct>
               <hasPrebuiltLicense>true</hasPrebuiltLicense>
               <prebuiltLicense>xxxx</prebuiltLicense>
               <hasAddonLicense>true</hasAddonLicense>
               <addonLicense>xxxx</addonLicense>
               <publisherIdName>
                  <name>id1</name>
               </publisherIdName>
               <addonLineItemData>

                  <activationId>e1_addOn1</activationId>
                  <enabledCount>1</enabledCount>
                  <consumedCount>1</consumedCount>
                  <licenseState>LICENSE_GENERATED</licenseState>
                  <entitledProducts>
                     <entitledProduct>
                        <product>

                           <primaryKeys>
                              <name>addOn1</name>
                              <version>1.0</version>
                           </primaryKeys>
                        </product>
                        <quantity>1</quantity>
                     </entitledProduct>
                  </entitledProducts>
               </addonLineItemData>
               <customAttributes>
                  <attribute>
                     <attributeName>LATITUDE</attributeName>
                     <stringValue>38</stringValue>
                  </attribute>
               </customAttributes>
            </device>
         </responseData>
      </getDevicesResponse>

Sample Failed Response Data:

If no devices match:

       <getDevicesResponse>
         <statusInfo>
            <status>SUCCESS</status>
         </statusInfo>
      </getDevicesResponse>