userResponse Type

userResponse is returned for all user operations except getList and getListRemote.

userResponse always contains the following common elements:

  • authToken
  • resultCount
  • statusCode
  • statusMessage
  • summaryOnly

If resultCount is 1 and statusCode is 2000 (successful), the resultSet element is included after resultCount listing the following User details:

  • loginName
  • firstName
  • lastName
  • loginPassword
  • phone
  • email
  • enabled
  • privileges
  • devices
  • appliances (createUser, createUserRemote, updateUser, and updateUserRemote only)
  • changeLoginName (updateUser and updateUserRemote only)

If resultCount is 0 and statusCode is not 2000 (successful), an error is returned in statusMessage.