FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Complex Type: deviceQueryDataType

Description

Note: Some elements apply only to served client devices while others apply only to server devices and client devices. Elements that start with feature are specific to served clients. Elements that start with addOn or preBuilt are specifc to server devices and client devices.

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
deviceIdentifier  deviceIdentifier  0..1  See deviceIdentifier.
alias  string  0..1  An alias for the device ID. If not set, the alias is defaulted by the application to the first 100 characters of the deviceIdentifier.
description  string  0..1  Device description.
hostTypeName  hostTypeIdentifier  0..1  See hostTypeIdentifier.
deviceStatus  deviceStatusType  0..1  ACTIVE or OBSOLETE.
deviceServedStatus  deviceServedStatusType  0..1 

The status of a served client device. One of the following:

  • NORMAL

  • RETURNED

  • EXPIRED

  • DROPPED

channelPartners  channelPartnerDataListType  0..1 

See channelPartnerDataListType.

Note: This element returns an account in the End Customer channel partner tier.

soldTo  soldToType  0..1  See soldToType.
soldToAcctName  soldToAcctNameType  0..1  See soldToAcctNameType.
preBuiltProduct  productPKType  0..1  Database primary key of the product—strings containing the name and version of the product.
hasPrebuiltLicense  boolean  0..1  Does the device have a prebuilt license?
prebuiltLicense  base64Binary  0..1  Actual prebuilt license.
hasAddonLicense  boolean  0..1  Does the device have a license?
addonLicense  base64Binary  0..1  Actual license.
publisherIdName  publisherIdentifier  0..1  See publisherIdentifier.
addonLineItemData  addonLineItemDataDataType  0..*  See addonLineItemDataDataType.
featureData  featureDataDataType  0..*  See featureDataDataType.
customAttributes  attributeDescriptorDataType  0..1  See attributeDescriptorDataType.
parentIdentifier  deviceIdentifier  0..1  The parentIdentifier element corresponds to the Served By value for a served client in the admin console UI; it identifies the served client’s parent FlexNet Embedded server device. See deviceIdentifier.
machineType  machineTypeType  0..1  The machineType can be UNKNOWN, PHYSICAL, or VIRTUAL.
vmName  string  0..1  The name of the virtual machine on which the device is hosted. If the machineType is not VIRTUAL, vmName is NULL.
vmInfo  dictionaryType  0..1  A BLOB of VM properties. See dictionaryType.
vendorDictionary  dictionaryType  0..1  A BLOB of vendor properties. See dictionaryType.
deviceUser  string  0..1 

This field is supported only for the tenants who have configured their Device User Option to On. The deviceUser string is returned only if the request's deviceResponseConfig contains deviceUser field, set to true.

  • If the Device User Option is set to Off, and the request's deviceResponseConfig has deviceUser field is true, the service will ignore it, and the response will state that the deviceUser response configuration is not supported.

  • If the Device User Option is set to On with no validation, the response will contain deviceUser field, set to the string value of the Device User.

  • If the Device User Option is set to On with validation and the deviceUser response configuration is set to true, the response will not populate the deviceUser for existing users, populating instead deviceUserIdentifier element with user's info. In cases when the user have been deleted, the deviceUser string will be set to<User System ID> (Removed).

deviceUserIdentifier  userIdentifierType  0..1 

See userIdentifierType. This field is returned when a tenant's Device User Option is set to On with validation and the response configuration's deviceUse is set to true. The response will contain the following information:

  • first name

  • last name

  • email address

  • user name

  • phone number

siteName  string  0..1  The getDevice, getDevicesQuery and searchDevices methods can return the siteName attribute value. You can use <responseConfig> to include or exclude the site name in the response. Also, siteName is available as a search parameter for the getDevicesQuery and searchDevices methods.