Element: getDevicesRequest

Description

A getDevicesRequest message contains an element of getDevicesRequestType.

Derived By

Type getDevicesRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
queryParams	getDevicesParametersType	0..1	See getDevicesParametersType.
deviceResponseConfig	deviceResponseConfigRequestType	0..1	Specifies the configuration settings to be included in the response. Includes the following boolean elements: alias description status servedStatus hostTypeName soldTo channelPartners preBuiltLicense addOnActivationId addOnCounts addOnProduct addOnLicense addOnExpirationDateOverride publisherIdentity parent machineType vmDetails vmInfo vendorDictionary deviceUser Note: If channelPartners is selected, the response includes only the account in the End Customer tier (bo.constants.partnertiernames.endcustomer).
pageNumber	integer	1..1	Required. Starts at 1. Say the operation using the same query parameters returns 100 records. If the batch size is 50 records and you want the second batch of 50, set pageNumber to 2.
batchSize	integer	1..1	Required. Maximum number of records to return in the response.

Referenced By

Name	Type
getDevicesQuery	Method

XML Example

The following XML fragment illustrates a getDevicesRequest message:

 <getDevicesRequest>
         <!--Optional:-->
         <queryParams>
            <!--Optional:-->
            <deviceId>
               <value>?</value>
               <searchType>?</searchType>
            </deviceId>
         </queryParams>
         <!--Optional:-->
         <deviceResponseConfig>
            <!--Optional:-->
            <alias>1</alias>
            <!--Optional:-->
            <description>1</description>
            <!--Optional:-->
            <status>1</status>
            <!--Optional:-->
            <servedStatus>1</servedStatus>
            <!--Optional:-->
            <hostTypeName>1</hostTypeName>
            <!--Optional:-->
            <soldTo>1</soldTo>
            <!--Optional:-->
            <channelPartners>1</channelPartners>
            <!--Optional:-->
            <preBuiltProduct>1</preBuiltProduct>
            <!--Optional:-->
            <preBuiltLicense>1</preBuiltLicense>
            <!--Optional:-->
            <addOnActivationId>1</addOnActivationId>
            <!--Optional:-->
            <addOnCounts>1</addOnCounts>
            <!--Optional:-->
            <addOnProduct>1</addOnProduct>
            <!--Optional:-->
            <addOnLicense>1</addOnLicense>
            <!--Optional:-->
            <features>1</features>
            <!--Optional:-->
            <customAttributes>
               <!--Zero or more repetitions:-->
               <attribute>
                  <attributeName>LATITUDE</attributeName>
               </attribute>
            </customAttributes>
            <!--Optional:-->
            <publisherIdentity>1</publisherIdentity>
            <!--Optional:-->
            <parent>1</parent>
            <machineType>1</machineType>
            <vmDetails>1</vmDetails>
            <vmInfo>1</vmInfo>
            <vendorDictionary>1</vendorDictionary>
         </deviceResponseConfig>
         <pageNumber>?</pageNumber>
         <batchSize>?</batchSize>
      </getDevicesRequest>