Element: queryParams [type getUserCountRequestType]

Description

Required. See userQueryParametersType. Leave this element blank to return all users.

Derived By

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
userName	SimpleQueryType	0..1	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.
firstName	SimpleQueryType	0..1	User first name.
lastName	SimpleQueryType	0..1	User last name.
displayName	SimpleQueryType	0..1	User’s display name.
emailAddress	SimpleQueryType	0..1	User’s email address.
phoneNumber	SimpleQueryType	0..1	User’s phone number.
faxNumber	SimpleQueryType	0..1	User’s fax number.
street	SimpleQueryType	0..1	Street portion of address.
city	SimpleQueryType	0..1	City portion of address.
state	SimpleQueryType	0..1	State portion of address.
zipcode	SimpleQueryType	0..1	Postal code.
country	SimpleQueryType	0..1	Country in which contact is located. Provide country in the two-character ISO-3166 format.
isActive	boolean	0..1	Is the user currently active?
canLogIn	boolean	0..1	Can the user log in? If not, user information is kept only for contact purposes.
accountIdList	accountIdList	0..1	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.
accountName	SimpleQueryType	0..1	Display name of any account to which the user belongs.
customAttributes	userCustomAttributesQueryListType	0..1	Custom attributes attached to this user. See userCustomAttributesQueryListType.
lastModifiedDateTime	DateTimeQueryType	0..1	Optional. The date and time at which the user account was last modified. See DateTimeQueryType.
accountType	AcctType	0..1	Optional. Defines the account type. accountType can be: CUSTOMER PUBLISHER CHANNEL_PARTNER SELF_REGISTERED Default: CUSTOMER.
roles	userAccountRolesListType	0..1	See userAccountRolesListType.
usersFromLinkedAccount	boolean	0..1	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.
sortBys	userSortBys	0..1	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

Referenced By

Name	Type
getUserCountRequestType	Complex Type

Definition

See getUserCountRequestType