FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Elements: UserAcctHierarchyService

Elements
Name  Description 
account [type accountDetailDataType]  See accountIdentifierType.
account [type createAcctRequestType]  See accountDataType.
account [type createdAccountDataListType]  See accountIdentifierType.
account [type createUserAccountType]  See accountIdentifierType.
account [type deleteAcctDataType]  Account identifier of parent account. See accountIdentifierType.
account [type failedCreateAcctDataType]  See accountDataType.
account [type getParentAccountsRequestType]  See accountIdentifierType.
account [type getRelatedAccountsRequestType]  See accountIdentifierType.
account [type getSubAccountsRequestType]  See accountIdentifierType.
account [type updateAcctDataType]  See accountIdentifierType.
account [type updateUserAccountRolesDataType]  See accountIdentifierType.
account [type updateUserAccountType]  See accountIdentifierType.
account [type userAccountType]  See accountIdentifierType.
accountExpiryData [type userAccountExpiryType]  See accountExpiryType.
accountID [type accountExpiryType] 

Required. The ID of the account. If not provided, the following error message displays:

User details cannot be fetched without account Id.
accountID [type accountIds]  Provide up to 10 account IDs to retrieve user information from multiple accounts.
accountID [type accountQueryParametersType]  Account ID.
accountID [type accountUserExpiryQueryParametersType] 

Required. The ID of the account. If not provided, the following error message displays:

User details cannot be fetched without account Id.
accountIdList [type userQueryParametersType]  Use to retrieve user information for multiple accounts using a single API call. To retrieve information for multiple accounts, specify up to 10 account IDs using the getUsersQuery API request.
accountIds [type accountIdList] 

Provide the account IDs for which you want to retrieve user information.

The configuration option Number of accounts and associated user information to retrieve via SOAP API limits the number of accounts that can be specified. Default = 10.

accountName [type accountQueryParametersType]  Account name.
accountName [type userQueryParametersType]  Display name of any account to which the user belongs.
accountRoles [type updateUserRolesDataType]  See updateUserAccountRolesDataType.
accountRolesList [type userDetailDataType]  List of the user’s roles. See userAccountsListType.
accountToRelate [type relateAccountsDataType]  Identifier of the account for which you want to define a channel partner relationship. See accountIdentifierType.
accountType [type accountDataType] 

Optional. Defines the account type. Valid values:

  • CUSTOMER

  • PUBLISHER

  • CHANNEL_PARTNER

Default: CUSTOMER. (You cannot use web services to create a new account with an accountType of SELF_REGISTERED.)

accountType [type accountDetailDataType] 

Optional. Defines the account type. accountType can be:

  • CUSTOMER

  • PUBLISHER

  • CHANNEL_PARTNER.

Default: CUSTOMER. (You cannot use web services to create a new account with an accountType of SELF_REGISTERED.)

accountType [type accountQueryParametersType] 

Optional. Defines the account type. accountType can be:

  • CUSTOMER

  • PUBLISHER

  • CHANNEL_PARTNER

Default: CUSTOMER. (You cannot use web services to create a new account with an accountType of SELF_REGISTERED.)

accountType [type accountTypeList]   
accountType [type accountUserExpiryQueryParametersType] 

Optional. Defines the account type. accountType can be:

  • CUSTOMER

  • PUBLISHER

  • CHANNEL_PARTNER

  • SELF_REGISTERED

Default: CUSTOMER.

accountType [type getUserPermissionsResponseDataType]  The account type of the first account the user belongs to.
accountType [type userQueryParametersType] 

Optional. Defines the account type. accountType can be:

  • CUSTOMER

  • PUBLISHER

  • CHANNEL_PARTNER

  • SELF_REGISTERED

Default: CUSTOMER.

accountTypeList [type accountQueryParametersType]  See accountTypeList.
acctData [type deleteAccountRequestType]  Account to be deleted. See deleteAcctDataType.
acctData [type failedDeleteAcctDataType]  See deleteAcctDataType.
acctData [type failedLinkAcctDataType]  See linkAccountsDataType.
acctData [type failedRelateAccountsDataType]  See relateAccountsDataType.
acctData [type failedUpdateAcctDataType]  See updateAcctDataType.
acctData [type getAccountsQueryResponseDataType]  See accountDetailDataType.
acctData [type linkAccountsRequestType]  Required. A link between exactly one root account and exactly one subaccount is expressed as an acctData element. A hierarchy with multiple root accounts or multiple sub accounts is constructed link by link with multiple acctData elements in a request. See linkAccountsDataType.
acctData [type relateAccountsRequestType]  Required. A relationship between two accounts is expressed as an acctData element. The accounts can be two CHANNEL_PARTNER accounts or a CHANNEL_PARTNER account and a CUSTOMER account. See relateAccountsDataType.
acctData [type updateAccountRequestType]  Account to be updated. See updateAcctDataType.
acctRoles [type createUserAccountsListType]  See createUserAccountType.
acctRoles [type updateUserAccountsListType]  List of account identifiers and roles. See updateUserAccountType.
acctRoles [type userAccountsListType]  See userAccountType.
acctRolesList [type createUserDataType]  Required. Set user's account and list of the user’s roles. User name and roles are required if the user can log in. See createUserAccountsListType.
acctRolesList [type updateUserDataType]  List of the user’s roles. See updateUserAccountsListType.
acctType [type AcctTypeList] 

Optional. Defines the account type. acctType can be:

  • CUSTOMER

  • PUBLISHER

  • CHANNEL_PARTNER

  • SELF_REGISTERED

Default: CUSTOMER.

activationId [type entitlementLineItemPKType]  The activationId of the entitlement line item.
addDomainUserRequest   
addDomainUserResponse   
address [type accountDataType]  Optional. Account physical address. See addressDataType.
address [type accountDetailDataType]  Account physical address. See addressDataType.
address [type updateAcctDataType]  Account physical address. See addressDataType.
address1 [type accountQueryParametersType]  First line of address.
address1 [type addressDataType]  First line of address.
address2 [type accountQueryParametersType]  Second line of address.
address2 [type addressDataType]  Second line of address.
arrayValue [type attributeDescriptorType]  Array of string values of the attribute.
ascending [type userSortBy]   
attribute [type acctCustomAttributesQueryListType]  See acctCustomAttributeQueryType.
attribute [type attributeDescriptorDataType]  attribute contains a required string attributeName and one attributeDescriptorType.
attribute [type attributeMetaDescriptorDataType]   
attribute [type customAttributeDescriptorDataType]   
attribute [type customAttributesQueryListType]  See customAttributeQueryType.
attribute [type userCustomAttributesQueryListType]  See userCustomAttributeQueryType.
attributeDataType [type attributeMetaDescriptorType]   
attributeName [type acctCustomAttributeQueryType]  Name of the custom attribute.
attributeName [type attributeDescriptorType]  Name of the attribute.
attributeName [type attributeMetaDescriptorType]   
attributeName [type customAttributeDescriptorType]   
attributeName [type customAttributeQueryType]  The name of the custom attribute.
attributeName [type userCustomAttributeQueryType]  Name of the custom attribute.
batchSize [type getAccountsQueryRequestType]  Required. Maximum number of records to return in the response.
batchSize [type getUserAccountsExpiryQueryRequestType]  Required. Maximum number of records to return in the response.
batchSize [type getUsersQueryRequestType]  Required. Maximum number of records to return in the response.
booleanValue [type attributeDescriptorType]  Boolean value of the attribute.
booleanValue [type customAttributeQueryType]  Optional. Depending on the attribute type, set either stringValue or numberValue or booleanValue. Set to true or false if the custom attribute is of type boolean.
canLogin [type createUserDataType]  Can the user log in? If not, user information is kept only for contact purposes.
canLogIn [type userQueryParametersType]  Can the user log in? If not, user information is kept only for contact purposes.
city [type accountQueryParametersType]  City.
city [type addressDataType]  City portion of address.
city [type createUserDataType]  City portion of address.
city [type updateUserDataType]  City portion of address.
city [type userDetailDataType]  City portion of address.
city [type userQueryParametersType]  City portion of address.
count [type getAccountCountResponseDataType]  Number of matching accounts.
count [type getCountResponseDataType]  A count element.
count [type getUserCountResponseDataType]  Number of matching users.
count [type productIdentifierWithCountDataType]  Required. Positive integer that indicates the cardinality of the product in the suite.
country [type accountQueryParametersType]  Two letter country code.
country [type addressDataType]  Country, in two-letter ISO-3166 code. If not provided, defaults to US.
country [type createUserDataType]  Two-letter country code.
country [type updateUserDataType]  Optional. Country in which contact is located. Provide country in the two-character ISO-3166 format.
country [type userDetailDataType]  Country in which contact is located. Provide country in the two-character ISO-3166 format.
country [type userQueryParametersType]  Country in which contact is located. Provide country in the two-character ISO-3166 format.
createAcctRequest  A createAcctRequest message contains an element of createAcctRequestType.
createAcctResponse  A createAcctResponse message contains an element of createAcctResponseType.
createdBy [type accountDetailDataType]  Name of the user who created the account.
createdBy [type userDetailDataType]  Name of the user who created the user account.
createdDate [type accountDetailDataType]  Timestamp representing the date the account was created.
createUserRequest  A createUserRequest message contains an element of createUserRequestType.
createUserResponse  A createUserResponse message contains an element of createUserResponseType.
customAttributes [type accountDataType]  Custom attributes attached to this account. See attributeDescriptorDataType.
customAttributes [type accountDetailDataType]  See attributeDescriptorDataType.
customAttributes [type accountQueryParametersType]  See acctCustomAttributesQueryListType.
customAttributes [type addDomainUserDataType]   
customAttributes [type createUserDataType]  Custom attributes attached to this user. See attributeDescriptorDataType.
customAttributes [type updateAcctDataType]  See attributeDescriptorDataType.
customAttributes [type updateDomainUserDataType]   
customAttributes [type updateUserDataType]  Custom attributes attached to this user. See attributeDescriptorDataType.
customAttributes [type userDetailDataType]  Custom attributes attached to this user. See attributeDescriptorDataType.
customAttributes [type userQueryParametersType]  Custom attributes attached to this user. See userCustomAttributesQueryListType.
dateCreated [type userDetailDataType]  Date the user account was created.
dateLastLogin [type userDetailDataType]  Date of user’s last login.
dateLastModified [type accountDetailDataType]  Timestamp representing the last time the account was modified.
dateLastModified [type userDetailDataType]  Date the user account was last modified.
dateValue [type attributeDescriptorType]  Date value of the attribute.
dateValue [type customAttributeQueryType] 

Optional. A dateValue element contains:

  • value—a date value to compare to the version date value.

  • searchType—one of the following datedSearchType values:

    • BEFORE

    • AFTER

    • ON

deleteAccountRequest  A deleteAccountRequest message contains an element of deleteAccountRequestType.
deleteAccountResponse  A deleteAccountResponse message contains an element of deleteAccountResponseType.
deleteDomainUserRequest   
deleteDomainUserResponse   
deleteSubTree [type deleteAcctDataType]  If true, deletes the entire account subtree as well. (Default value is true.)
deleteUserRequest  A deleteUserRequest message contains an element of deleteUserRequestType.
deleteUserResponse  A deleteUserResponse message contains an element of deleteUserResponseType.
description [type accountDataType]  Optional. Description of the account.
description [type accountDetailDataType]  Account description.
description [type accountQueryParametersType]  Account description.
description [type updateAcctDataType]  Description of the account.
displayName [type createUserDataType]  User’s display name.
displayName [type updateUserDataType]  User’s display name.
displayName [type userDetailDataType]  User’s display name.
displayName [type userQueryParametersType]  User’s display name.
domain [type addDomainUserDataType]   
domain [type userDetailDataType]  User’s domain.
domainName [type domainUserPKType]   
domainName [type getUserPermissionsRequestType]  The previous username's domain.
domainUser [type updateDomainUserDataType]   
duration [type versionDateAttributesType]  Optional. See DurationType.
durationUnit [type DurationType] 

Required. Specify one of the following units of time:

  • DAYS

  • WEEKS

  • MONTHS

  • YEARS

email [type updateDomainUserDataType]   
emailAddress [type createUserDataType]  User’s email address. Required.
emailAddress [type updateUserDataType]  User’s email address.
emailAddress [type userPKType]  User’s email address.
emailAddress [type userQueryParametersType]  User’s email address.
emailId [type emailContactListType]  List of email addresses to which to send license certificate.
entitledProduct [type entitledProductDataListType]  See entitledProductDataType.
entitledProducts [type updateEntitledProductDataListType]  See entitledProductDataType.
entitlementId [type entitlementPKType]  The entitlement ID of the entitlement.
expiryDate [type accountExpiryType]  The date the user's access to an account expires.
expiryDate [type accountUserExpiryQueryParametersType]  See DateQueryType.
expiryDate [type createUserAccountType] 

Optional. Date the user is no longer linked to the account. If included, the value cannot be null. If not included, the user's access to the account will not expire.

Note: If the Enable User Expiration is not selected in the FlexNet Operations system configuration, the following error message will result:

User Account Expiration Configuration is Disabled.
expiryDate [type updateUserAccountType] 

Optional. Date the user is no longer linked to the account. If included, the value cannot be null. If not included, there will be no change to the user's existing expiration date setting.

Note 1: Because the field cannot contain a null value, to clear a previously set expiration date for a user, you must edit the Expiry date field for the user in the FlexNet Operations Producer Portal. Alternatively, using the web services, the expiration date can be set to far enough in the future that it, in effect, never expires.

Note 2: If the Enable User Expiration is not selected in the FlexNet Operations system configuration, the following error message will result:

User Account Expiration Configuration is Disabled.
expiryDate [type userDetailDataType] 

Optional. Date the user is no longer linked to the account. If included, the value cannot be null.

Note: Because the field cannot contain a null value, to clear the expiry date for a user, you must edit the Expiry date field for the user in the FlexNet Operations Producer Portal. Alternatively, using the web services, the expiry date can be set to far enough in the future that it, in effect, never expires.

failedAccount [type failedUpdateAcctDataListType]  See failedUpdateAcctDataType.
failedAcct [type failedCreateAcctDataListType]  See failedCreateAcctDataType.
failedAcct [type failedDeleteAcctDataListType]  See failedDeleteAcctDataType.
failedAcctData [type failedLinkAcctDataListType]  See failedLinkAcctDataType,
failedAcctData [type failedRelateAccountsDataListType]  See failedRelateAccountsDataType.
failedData [type addDomainUserResponseType]   
failedData [type createAcctResponseType]  See failedCreateAcctDataListType.
failedData [type createUserResponseType]  See failedCreateUserDataListType.
failedData [type deleteAccountResponseType]  See failedDeleteAcctDataListType.
failedData [type deleteDomainUserResponseType]   
failedData [type deleteUserResponseType]  See failedDeleteUserDataListType.
failedData [type linkAccountsResponseType]  See failedLinkAcctDataListType.
failedData [type relateAccountsResponseType]  See failedRelateAccountsDataListType.
failedData [type updateAccountResponseType]  See failedUpdateAcctDataListType.
failedData [type updateDomainUserResponseType]  See failedUpdateDomainUserDataListType
failedData [type updateUserResponseType]  See failedUpdateUserDataListType.
failedData [type updateUserRolesResponseType]  See failedUpdateUserRolesDataListType.
failedUser [type failedAddDomainUserDataListType]   
failedUser [type failedCreateUserDataListType]  See failedCreateUserDataType.
failedUser [type failedDeleteDomainUserDataListType]   
failedUser [type failedDeleteUserDataListType]  See failedDeleteUserDataType.
failedUser [type failedUpdateDomainUserDataListType]   
failedUser [type failedUpdateUserDataListType]  See failedUpdateUserDataType.
failedUser [type failedUpdateUserRolesDataListType]  See failedUpdateUserRolesDataType.
faxNumber [type createUserDataType]  User’s fax number.
faxNumber [type updateUserDataType]  User’s fax number.
faxNumber [type userDetailDataType]  User’s fax number.
faxNumber [type userQueryParametersType]  User’s fax number.
firstName [type createUserDataType]  User first name. Required.
firstName [type updateUserDataType]  User first name.
firstName [type userPKType]  User’s first name.
firstName [type userQueryParametersType]  User first name.
forceDelete [type forceDeleteUserIdentifierType]   
fulfillmentId [type fulfillmentPKType]  The fulfillmnet ID.
getAccountCountRequest  A getAccountCountRequest message contains an element of getAccountCountRequestType.
getAccountCountResponse  A getAccountCountResponse message contains an element of getAccountCountResponseType.
getAccountsQueryRequest  See getAccountsQueryRequest message contains an element of getAccountsQueryRequestType.
getAccountsQueryResponse  See getAccountsQueryResponse message contains an element of getAccountsQueryResponseType.
getParentAccountsRequest  A getParentAccountsRequest message contains an element of getParentAccountsRequestType.
getParentAccountsResponse  A getParentAccountsResponse message contains an element of getParentAccountsResponseType.
getRelatedAccountsRequest  A getRelatedAccountsRequest message contains an element of getRelatedAccountsRequestType.
getRelatedAccountsResponse  A getRelatedAccountsResponse message contains an element of getRelatedAccountsResponseType.
getSubAccountsRequest  A getSubAccountsRequest message contains an element of getSubAccountsRequestType.
getSubAccountsResponse  A getSubAccountsResponse message contains an element of getSubAccountsResponseType.
getUserAccountsExpiryQueryRequest  A getUserAccountsExpiryQueryRequest message contains an element of getUserAccountsExpiryQueryRequestType.
getUserAccountsExpiryQueryResponse  A getUserAccountsExpiryQueryResponse message contains an element of getUserAccountsExpiryQueryResponseType.
getUserCountRequest  A getUserCountRequest message contains an element of getUserCountRequestType.
getUserCountResponse  A getUserCountResponse message contains an element of getUserCountResponseType.
getUserPermissionsRequest  A getUserPermissionsRequest message contains an element of getUserPermissionsRequestType.
getUserPermissionsResponse  A getUserPermissionsResponse message contains an element of getUserPermissionsResponseType.
getUsersQueryRequest  A getUsersQueryRequest message contains an element of getUsersQueryRequestType.
getUsersQueryResponse  A getUsersQueryResponse message contains an element of getUsersQueryResponseType.
id [type accountDataType]  Required. Displayed as Account Identifier (short account name) in the web interface.
id [type accountPKTypeUser]   
id [type updateAcctDataType]  Account identifier (short account name) of the account.
integerValue [type attributeDescriptorType]  Integer value of the attribute.
isActive [type userQueryParametersType]  Is the user currently active?
keyName [type trustedKeyPKType]  The keyName of the transaction key.
lastModifiedBy [type accountDetailDataType]  Name of the user who last modified the account.
lastModifiedBy [type userDetailDataType]  Name of the user who last modified the user account.
lastModifiedDateTime [type accountQueryParametersType]  See DateTimeQueryType.
lastModifiedDateTime [type userQueryParametersType]  Optional. The date and time at which the user account was last modified. See DateTimeQueryType.
lastName [type createUserDataType]  User last name. Required.
lastName [type updateUserDataType]  User last name.
lastName [type userPKType]  User’s last name.
lastName [type userQueryParametersType]  User last name.
licenseModel [type partNumberIdentifierWithModelType]  Optional, if you want to map a part number for a product to one specific license model linked to the product. See licenseModelIdentifierType.
linkAccountsRequest  A linkAccountsRequest message contains an element of linkAccountsRequestType.
linkAccountsResponse  A linkAccountsResponse message contains an element of linkAccountsResponseType.
locale [type addDomainUserDataType]   
locale [type createUserDataType]  User’s locale.
locale [type updateDomainUserDataType]   
locale [type updateUserDataType]  Optional. A string containing one of the locale settings supported by Java, for example, en_US.
locale [type userDetailDataType]  Optional. A string containing one of the locale settings supported by Java, for example, en_US.
name [type accountDataType]  Required. Displayed as Account Name (full account name) in the web interface.
name [type accountDetailDataType]  The account name.
name [type accountIdentifierTypeUser]   
name [type featureBundlePKType]  The name of the feature bundle.
name [type featurePKType]  The name of the feature.
name [type hostTypePKType]  The name of the host type.
name [type licenseGeneratorPKType]  The name of the license generator configuration.
name [type licenseModelPKType]  The name of the license model.
name [type licenseTechnologyPKType]  The name of the license technology.
name [type maintenancePKType]  The name of the maintenance product.
name [type productPKType]  The name of the product.
name [type rolePKType]  Name of the role.
name [type suitePKType]  The name of the suite.
name [type updateAcctDataType]  Account name (full account name) of the account.
namespace [type attributeMetaDescriptorType]   
numberValue [type customAttributeQueryType] 

Optional. Depending on the attribute type, set either stringValue or numberValue or booleanValue.

A numberValue element contains:

  • value—an integer number to match part or all of the custom attribute value.

  • searchType—one of the following simpleSearchType values:

    • GREATER_THAN

    • GREATER_THAN_EQUALS

    • LESS_THAN

    • LESS_THAN_EQUALS

    • EQUALS

    • NOT_EQUALS

numDuration [type DurationType]  Required. Specify the number of units of time, for example, 10, for a duration of 10 durationUnit.
onlyRootAccounts [type accountQueryParametersType]  If true, returns only root accounts.
optIn [type addDomainUserDataType]   
optIn [type createUserDataType]  Required. Does the user wish to receive email?
optIn [type updateDomainUserDataType]   
optIn [type updateUserDataType]  Does the user wish to receive email?
optIn [type userDetailDataType]  Does the user wish to receive email?
opType [type createAcctRequestType] 

Specifies how FlexNet Operations behaves when creating accounts. For details, see CreateOrUpdateOperationType.

If no opType is set, FlexNet Operations creates the specified account unless the account already exists. When the account already exists, the operation fails.

opType [type createUserRequestType] 

Specifies how FlexNet Operations behaves when creating users. For details, see CreateOrUpdateOperationType.

  • If no opType is set, FlexNet Operations creates the specified user unless the user or contact already exists. When the user or contact already exists, the operation fails.

  • If the user does not exist and the opType is set to either CREATE_OR_UPDATE or CREATE_OR_IGNORE, the operation will succeed unless the existing contact already belongs to another user. If the contact exists but does not belong to another user, it will create the user and update the contact with the new user.

  • If both the user and contact exist and the opType is set to CREATE_OR_UPDATE, the request will update the contact.

  • If both the user and contact exist and the opType is set to CREATE_OR_IGNORE, the request will not update the contact.

opType [type updateEntitledProductDataListType] 

Required. Specify one of the following for each entitlement to be modified:

  • REPLACE

  • ADD

  • DELETE

opType [type updateRelatedAccountsListType] 

Type of operation performed on the account.

  • ADD—add a link to this related account.

  • REPLACE—replace all current links to related accounts with a link to this account.

  • DELETE—remove the link between the account and this related account.

opType [type updateSubAccountsListType] 

Type of operation performed on the account.

  • ADD—add a link to this subaccount.

  • REPLACE—replace all current links to first-level subaccounts with a link to this one.

  • DELETE—remove the link between the parent and this subaccount, promoting the subaccount to a root account if it is not linked to any other parent accounts.

opType [type updateUserAccountsListType] 

Type of operation performed on the user’s accounts and roles.

  • ADD—add the user to the account.

  • REPLACE—replace all current links to accounts. Unlike in the Admin Console, it is possible to replace a link from one type of account to another type.

  • DELETE—remove the link between the user and account, only if the user is linked to another account.

opType [type updateUserRolesListType] 

Type of operation performed on the user.

  • ADD—assign the user to a role.

  • REPLACE—replace a current role assignment.

  • DELETE—remove the link between the user and a role.

organization [type updateDomainUserDataType]   
pageNumber [type getAccountsQueryRequestType]  Required. Starts at 1. Say the getAccountsQuery 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.
pageNumber [type getUserAccountsExpiryQueryRequestType]  Required. Starts at 1. Say the getUserAccountsExpiryQuery 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.
pageNumber [type getUsersQueryRequestType]  Required. Starts at 1. Say the getUsersQuery 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.
parentAcct [type linkAccountsDataType]  Identifier of the parent account. See accountIdentifierType.
partId [type partNumberPKType]  The partId of the part number.
permission [type permissionListType]  The permission that the user has been granted.This will be shown as a string roughly in the format "platform:view.and.manage.users".
permissions [type getUserPermissionsResponseDataType]  The list of permissions that the user has been granted. This will be shown as a string roughly in the format "platform:view.and.manage.users". See permissionListType.
phoneNumber [type createUserDataType]  User’s phone number.
phoneNumber [type updateUserDataType]  User’s phone number.
phoneNumber [type userPKType]  User’s phone number.
phoneNumber [type userQueryParametersType]  User’s phone number.
primaryKeys [type accountIdentifierTypeUser]   
primaryKeys [type domainUserIdentifierType]   
primaryKeys [type entitlementIdentifierType]  Database primary key of the entitlement—string containing the entitlementId of the entitlement. See entitlementPKType.
primaryKeys [type entitlementLineItemIdentifierType]  Database primary key of the entitlement line item—string containing the activationId of the entitlement line item. See entitlementLineItemPKType.
primaryKeys [type featureBundleIdentifierType]  Database primary key of the feature bundle—a string containing the name of the feature bundle. See featureBundlePKType.
primaryKeys [type featureIdentifierType]  Database primary keys of the feature—strings containing name and, if the feature version format is FIXED, the version of the feature. If the feature version format is DATE_BASED, specify only name. See featurePKType.
primaryKeys [type fulfillmentIdentifierType]  Database primary key of the fulfillment—a string containing the fulfillmentID. See fulfillmentPKType.
primaryKeys [type licenseGeneratorIdentifierType]  Database primary key of the license generator configuration—string containing the name of the license generator configuration. See licenseGeneratorPKType.
primaryKeys [type licenseModelIdentifierType]  Database primary key of the license model—a string containing the name of the license model. See licenseModelPKType.
primaryKeys [type licenseTechnologyIdentifierType]  Database primary key of the license technology—string containing the name of the license technology. See licenseTechnologyPKType.
primaryKeys [type maintenanceIdentifierType]  Database primary key of the maintenance product—strings containing the name and version of the maintenance product. See maintenancePKType.
primaryKeys [type partNumberIdentifierType]  Database primary key of the part number—string containing the partId of the part number. See partNumberPKType.
primaryKeys [type partNumberIdentifierWithModelType]  Database primary key of the part number—a string containing the partId of the part number. See partNumberPKType.
primaryKeys [type productIdentifierType]  Database primary key of the product—strings containing the name and version of the product. See productPKType.
primaryKeys [type roleIdentifierType]  Name of the role. See rolePKType.
primaryKeys [type suiteIdentifierType]  Database primary key of the suite—strings containing the name and version of the suite. See suitePKType.
primaryKeys [type trustedKeyIdentifierType]  Database primary key of the transaction key—a string containing the keyName of the transaction key. See trustedKeyPKType.
primaryKeys [type userIdentifierType]  See userPKType.
product [type entitledProductDataType]  See productIdentifierType.
productIdentifier [type productIdentifierWithCountDataType]  Required. See productIdentifierType.
quantity [type entitledProductDataType]  Quantity per copy of the line item. This is a multiplier to the number of copies. If one copy of the line item is fulfilled, this many copies of the entitled product will be fulfilled.
queryParams [type getAccountCountRequestType]  Required. See accountQueryParametersType. Leave this element blank to return all CUSTOMER accounts.
queryParams [type getAccountsQueryRequestType]  Required. See accountQueryParametersType. Leave this element blank to return all CUSTOMER accounts.
queryParams [type getUserAccountsExpiryQueryRequestType]  See accountUserExpiryQueryParametersType.
queryParams [type getUserCountRequestType]  Required. See userQueryParametersType. Leave this element blank to return all users.
queryParams [type getUsersQueryRequestType]  Required. See userQueryParametersType. Leave this element blank to return all users.
reason [type failedAddDomainUserDataType]   
reason [type failedCreateAcctDataType]  Reason for failure.
reason [type failedCreateUserDataType]  Reason for failure.
reason [type failedDeleteAcctDataType]  Reason for failure.
reason [type failedDeleteDomainUserDataType]   
reason [type failedDeleteUserDataType]  Reason for failure.
reason [type failedLinkAcctDataType]  Reason for failure.
reason [type failedRelateAccountsDataType]  Reason for failure.
reason [type failedUpdateAcctDataType]  Reason for failure.
reason [type failedUpdateDomainUserDataType]   
reason [type failedUpdateUserDataType]  Reason for failure.
reason [type failedUpdateUserRolesDataType]  Reason for failure.
reason [type StatusInfoType]  Gives reason for partial failure or failure.
recordRefNo [type correlationDataType]   
region [type accountQueryParametersType]  Region.
region [type addressDataType]  Address region.
relateAccountsRequest  A relateAccountsRequest message contains an element of relateAccountsRequestType.
relateAccountsResponse  A relateAccountsResponse message contains an element of relateAccountsResponseType.
relatedAccount [type relateAccountsDataType]  Identifier of the account to relate to account defined in accountToRelate. See accountIdentifierType.
relatedAccount [type updateRelatedAccountsListType]  Array of account identifiers of related accounts. See accountIdentifierType.
relatedAccounts [type updateAcctDataType]  See updateRelatedAccountsListType.
responseData [type addDomainUserResponseType]   
responseData [type createAcctResponseType]  See createdAccountDataListType.
responseData [type createUserResponseType]  See createdUserDataListType.
responseData [type getAccountCountResponseType]  See getAccountCountResponseDataType.
responseData [type getAccountsQueryResponseType]  See getAccountsQueryResponseDataType.
responseData [type getParentAccountsResponseType]  See getAccountsQueryResponseDataType.
responseData [type getRelatedAccountsResponseType]  See getAccountsQueryResponseDataType.
responseData [type getSubAccountsResponseType]  See getAccountsQueryResponseDataType.
responseData [type getUserAccountsExpiryQueryResponseType]  See getUserAccountsExpiryQueryResponseDataType.
responseData [type getUserCountResponseType]  See getUserCountResponseDataType.
responseData [type getUserPermissionsResponseType]  See getUserPermissionsResponseDataType.
responseData [type getUsersQueryResponseType]  See getUsersQueryResponseDataType.
responseData [type updateDomainUserResponseType]  See updatedDomainUserDataListType
role [type createUserAccountRolesListType]  See roleIdentifierType.
role [type updateUserRolesAccountListType]  See roleIdentifierType.
role [type updateUserRolesListType]  See roleIdentifierType.
roleName [type userAccountRolesListType]  User's role name.
roles [type addDomainUserDataType]   
roles [type createUserAccountType]  See createUserAccountRolesListType.
roles [type updateDomainUserDataType]   
roles [type updateUserAccountRolesDataType]  See updateUserRolesListType.
roles [type updateUserAccountType]  See updateUserRolesAccountListType.
roles [type userAccountType]  See userAccountRolesListType.
roles [type userQueryParametersType]  See userAccountRolesListType.
searchType [type accountIdList] 

Search criteria for one account ID would be:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

Search criteria would be EQUALS if more than one account ID is provided to retrieve user information.

searchType [type DateQueryType] 

One of the following datedSearchType values:

  • BEFORE

  • AFTER

  • ON

searchType [type DateTimeQueryType] 

One of the following datedSearchType values:

  • BEFORE

  • AFTER

  • ON

searchType [type NumberQueryType] 

One of the following numberSearchType values:

  • GREATER_THAN

  • GREATER_THAN_EQUALS

  • LESS_THAN

  • LESS_THAN_EQUALS

  • EQUALS

  • NOT_EQUALS

searchType [type SimpleQueryType]   
searchType [type StateQueryType] 

One of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

searchType [type VersionFormatQueryType] 

One of the following simpleSearchType values:

  • STARTS_WITH

  • CONTAINS

  • ENDS_WITH

  • EQUALS

shared [type createUserDataType]  Is this a shared login among several users?
shared [type updateUserDataType]  Is this a shared login among several users?
shared [type userDetailDataType] 

Optional. Corresponds to the Shared Login control in the administrative console UI. The shared element can be true or false.

  • true—Shared Login is enabled for the user account. This is useful when the same user account is used to log in to FlexNet Operations simultaneously from different instances. Logged in history is not written to the database.

  • false—Shared Login is not enabled for the user account.

sortBy [type userSortBys]   
sortBys [type userQueryParametersType] 

Enables producers who are building their own Web portal to sort columns.

Only one sortBy parameter can be sent per request.

Here is an example request:

<urn:sortBys>
  <urn:sortBy>
    <urn:sortKey>EMAIL</urn:sortKey>
    <urn:ascending>false</urn:ascending>
  </urn:sortBy>
</urn:sortBys>

The following fields can be sorted:

  • ACCOUNT_NAME

  • ACCOUNT_ID

  • CAN_LOGIN

  • CITY

  • COUNTRY

  • DISPLAY_NAME

  • EMAIL

  • FIRST_NAME

  • ISACTIVE

  • LAST_MODIFIED

  • LAST_NAME

  • STATE

sortKey [type userSortBy]   
state [type accountQueryParametersType]  State.
state [type addressDataType]  State portion of address.
state [type createUserDataType]  State portion of address.
state [type updateUserDataType]  State portion of address.
state [type userDetailDataType]  State portion of address.
state [type userQueryParametersType]  State portion of address.
status [type addDomainUserDataType]   
status [type createUserDataType] 

Status can be one of the following values:

  • Active

  • Inactive

status [type StatusInfoType]  See StatusType.
status [type updateDomainUserDataType]   
status [type updateUserDataType] 

Status can be one of the following values:

  • Active

  • Inactive

status [type userDetailDataType] 

Status can be one of the following values:

  • Active

  • Inactive

statusInfo [type addDomainUserResponseType]   
statusInfo [type createAcctResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type createUserResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type deleteAccountResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type deleteDomainUserResponseType]   
statusInfo [type deleteUserResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type getAccountCountResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type getAccountsQueryResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type getParentAccountsResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type getRelatedAccountsResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type getSubAccountsResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type getUserAccountsExpiryQueryResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason

string

Gives reason for partial failure or failure.

statusInfo [type getUserCountResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type getUserPermissionsResponseType] 
Element  Status Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type getUsersQueryResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type linkAccountsResponseType] 
Element  Data Type  Descriptionik 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type relateAccountsResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type updateAccountResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type updateDomainUserResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type updateUserResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
statusInfo [type updateUserRolesResponseType] 
Element  Data Type  Description 
status
StatusType

Returns one of the following:

  • SUCCESS—All features in the request were processed.

  • PARTIAL_FAILURE—Some, but not all features in the request were processed. The getCount and getQuery operations never return PARTIAL_FAILURE.

  • FAILURE—None of the features in the request were processed.

reason
string
Gives reason for partial failure or failure.
 
street [type createUserDataType]  Street portion of address.
street [type updateUserDataType]  Street portion of address.
street [type userDetailDataType]  Street portion of address.
street [type userQueryParametersType]  Street portion of address.
stringValue [type acctCustomAttributeQueryType]  A string to match part or all of the custom attribute value.
stringValue [type attributeDescriptorType]  String value of the attribute.
stringValue [type customAttributeQueryType] 

Optional. Depending on the attribute type, set either stringValue or numberValue or booleanValue.

A stringValue element contains:

  • value—a string to match part or all of the custom attribute value.

  • searchType—one of the following simpleSearchType values:

    • STARTS_WITH

    • CONTAINS

    • ENDS_WITH

    • EQUALS

stringValue [type userCustomAttributeQueryType]  Value of the custom attribute.
subAccount [type updateSubAccountsListType]  Array of account identifiers of subaccounts. See accountIdentifierType.
subAccounts [type updateAcctDataType]  See updateSubAccountsListType.
subAcct [type linkAccountsDataType]  Identifiery of the subaccount. See accountIdentifierType.
timeZone [type addDomainUserDataType]   
timezone [type createUserDataType] 

Optional. Provide time zone setting in one of the following formats:

  • ISO-8601 format (+/-hh:mm) as an offset from GMT. For example, -08:00 or +05:30 (note that the string GMT is not included in the value). A value of Z corresponds to GMT.

  • GMT#.#DST#

When a user is saved, this offset is converted to a time zone string and the time zone string is displayed when a user is retrieved.

timeZone [type updateDomainUserDataType]   
timezone [type updateUserDataType] 

Optional. Provide time zone setting in one of the following formats:

  • ISO-8601 format (+/-hh:mm) as an offset from GMT. For example, -08:00 or +05:30 (note that the string GMT is not included in the value). A value of Z corresponds to GMT.

  • GMT#.#DST# 

When a user is saved, this offset is converted to a time zone string and the time zone string is displayed when a user is retrieved.

timezone [type userDetailDataType] 

Optional. Provide time zone setting in one of the followig formats:

  • ISO-8601 format (+/-hh:mm) as an offset from GMT. For example, -08:00 or +05:30 (note that the string GMT is not included in the value). A value of Z corresponds to GMT.

  • GMT#.#DST# 

When a user is saved, this offset is converted to a time zone string, and the time zone string is displayed when a user is retrieved.

uniqueId [type accountIdentifierTypeUser]   
uniqueId [type correlationDataType]   
uniqueId [type domainUserIdentifierType]   
uniqueId [type entitlementIdentifierType]  Unique database identifier of the entitlement.
uniqueId [type entitlementLineItemIdentifierType]  Unique database identifier of the entitlement line item.
uniqueId [type featureBundleIdentifierType]  Unique database identifier of the feature bundle.
uniqueId [type featureIdentifierType]  Unique database identifier of the feature.
uniqueId [type fulfillmentIdentifierType]  Unique database identifier of the fulfillment.
uniqueId [type licenseGeneratorIdentifierType]  Unique database identifier of the license generator configuration.
uniqueId [type licenseModelIdentifierType]  Unique database identifier of the license model.
uniqueId [type licenseTechnologyIdentifierType]  Unique database identifier of the license technology.
uniqueId [type maintenanceIdentifierType]  Unique database identifier of the maintenance product.
uniqueId [type partNumberIdentifierType]  Unique database identifier of the part number.
uniqueId [type partNumberIdentifierWithModelType]  Unique database identifier of the part number.
uniqueId [type productIdentifierType]  Unique database identifier of the product.
uniqueId [type roleIdentifierType]  Role ID.
uniqueId [type suiteIdentifierType]  Unique database identifier of the suite.
uniqueId [type trustedKeyIdentifierType]  Unique database identifier of the transaction key.
uniqueId [type userIdentifierType]  User’s unique ID.
updateAccountRequest  An updateAccountRequest message contains one or more elements of updateAccountRequestType.
updateAccountResponse  An updateAccountResponse message contains an element of updateAccountResponseType.
updateDomainUserRequest   
updateDomainUserResponse   
updateUserRequest  An updateUserRequest message contains an element of updateUserRequestType.
updateUserResponse  An updateUserResponse message contains an element of updateUserResponseType.
updateUserRolesRequest  An updateUserRolesRequest message contains an element of updateUserRolesRequestType.
updateUserRolesResponse  An updateUserRolesResponse message contains an element of updateUserRolesResponseType.
user [type addDomainUserRequestType]   
user [type addedDomainUserDataListType]   
user [type createdUserDataListType]  See userIdentifierType.
user [type createUserRequestType]  Required. See createUserDataType.
user [type deleteDomainUserRequestType]   
user [type deleteUserRequestType]  User to be deleted. See userIdentifierType.
user [type failedAddDomainUserDataType]   
user [type failedCreateUserDataType]  See createUserDataType.
user [type failedDeleteDomainUserDataType]   
user [type failedDeleteUserDataType]  See userIdentifierType.
user [type failedUpdateDomainUserDataType]   
user [type getUsersQueryResponseDataType]  See userDetailDataType.
user [type updatedDomainUserDataListType]   
user [type updateDomainUserRequestType]   
user [type updateUserDataType]  Identifies the user being updated. See userIdentifierType. Required. All other elements are optional.
user [type updateUserRolesDataType]  See userIdentifierType.
userAccountExpiryData [type getUserAccountsExpiryQueryResponseDataType]  See userAccountExpiryType.
userData [type failedUpdateUserDataType]  See updateUserDataType.
userData [type failedUpdateUserRolesDataType]  See updateUserRolesDataType.
userData [type updateUserRequestType]  User to be updated. See updateUserDataType.
userData [type updateUserRolesRequestType]  User to be updated. See updateUserRolesDataType.
userData [type userAccountExpiryType]  See userDetailDataType.
userId [type addDomainUserDataType]   
userIdentifier [type userDetailDataType]  See userIdentifierType.
userName [type createUserDataType] 

User’s FlexNet Operations login name.

  • If canLogin is set to false, this field is ignored.

  • if canLogin is set to true, this field is required.

Important: The user name must match the email address for the user. If the user name is set to something other than the user's email address, certain features such as accessing ESD components, may not be available.

userName [type domainUserPKType]   
userName [type getUserPermissionsRequestType]  The username for which permissions will be retrieved.
userName [type getUserPermissionsResponseDataType]  The username from the input.
userName [type userIdentifierType]  User’s FlexNet Operations login name.
userName [type userQueryParametersType] 

User’s FNO user name.

  • If canLogin is set to false, this fields is ignored.

  • If canLogin is set to true, this field is required.

usersFromLinkedAccount [type userQueryParametersType] 

A query for a parent account ID with usersFromLinkedAccount set to true would return users from all sub-accounts that are directly linked to the parent account.

The field is available for the getUsersQuery and getUsersCount operations.

validValues [type attributeMetaDescriptorType]   
value [type DateQueryType]  A date value to compare.
value [type DateTimeQueryType]  A date and time value to compare to the last modified date and time value. For example, 2011-05-04T22:00:00.
value [type NumberQueryType]  Number to match part or all of the attribute value.
value [type SimpleQueryType]   
value [type StateQueryType]  StateType value of TEST, DRAFT, DEPLOYED, INACTIVE, OBSOLETE to match part or all of the state value.
value [type valueType]  Valid values for a MULTI_VALUED_TEXT license model attribute.
value [type VersionFormatQueryType]  VersionFormatType of FIXED or DATE_BASED.
version [type featurePKType]  The version of the feature.
version [type maintenancePKType]  The version of the maintenance product.
version [type productPKType]  The version of the product.
version [type suitePKType]  The version of the suite.
versionOption [type versionDateAttributesType]  See VersionDateOptionType.
visible [type accountDataType]  Optional. Applicable to CUSTOMER and CHANNEL_PARTNER accounts, visible determines whether or not an account unrelated to this account can see the name of this account when it is in a channel partner tier of an entitlement, line item, or device. If visible is false, this account will appear as Name Withheld to unrelated accounts. Default: true.
visible [type accountDetailDataType]  Optional. Applicable to CUSTOMER and CHANNEL_PARTNER accounts, visible determines whether or not an account unrelated to this account can see the name of this account when it is in a channel partner tier of an entitlement, line item, or device. If visible is false, this account will appear as Name Withheld to unrelated accounts. Default: true.
visible [type updateAcctDataType]  Optional. Applicable to CUSTOMER and CHANNEL_PARTNER accounts, visible determines whether or not an account unrelated to this account can see the name of this account when it is in a channel partner tier of an entitlement, line item, or device. If visible is false, this account will appear as Name Withheld to unrelated accounts. Default: true.
zipcode [type accountQueryParametersType]  Postal code.
zipcode [type addressDataType]  Postal code.
zipcode [type createUserDataType]  Postal code.
zipcode [type updateUserDataType]  Postal code.
zipcode [type userDetailDataType]  Postal code.
zipcode [type userQueryParametersType]  Postal code.