Get Users

Last updated
Save as PDF

getUsers

Given a company ID (if no company is specified, the company of the authorized user will be used) and optionally an entity ID and entity type to filter on, this web service returns a list of User objects in alphabetical order by User ID. If filtration information (entityId and entityType) is specified, a subset of the company's users matching the criteria will be returned, otherwise all users in the company will be returned.

User[] getUsers(string companyId, string entityId, string entityType) throws WSException

companyId: (optional) A string of maximum length 10 that specifies the unique company identifier.
entityId: (optional) A string that indicates the unique identifier of the entity specified in the entityType field.

entityType: (optional) A character that indicates the type of entity specified in the entityId field for filtration. Valid values are:

Value	Description	Filtration Info
U	User ID	Returns user information for the specified user
A	Application ID See Application Information for App ID values	Returns a list of users authorized for the specified application
R	Role Name	Returns a list of users with the specified role name
null or blank	All Users	No filtration applied.

Returns a null string on exceptions; otherwise returns an array of User objects.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Admin role (If requesting information about a user other than themselves.)

Customer integrators are authorized to their own company's data only.

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<getUsers>

<companyId>MYCOMPANY</companyId>

<entityId>QTRACS</entityId>

<entityType>A</entityType>

</getUsers>

</soap:Body>

Sample XML Response

<soapenv:Body>

<getUsersResponse>

<getUsersReturn>

<User>

<id>ROMANOWSKI</id>

<qspInstance>1</QSPinstance>

<companyId>MYCOMPANY</companyId>

<firstName>Nick</firstName>

<lastName>Romanowski</lastName>

<role>

<name>Admin</name>

<description>Administrator</description>

</role>

<email>romanowski@mycompany.com</email>

<pagerEmail>nick@mycompany.com</pagerEmail>

<timeZone>

<gmtOffset>GMT-08:00</gmtOffset>

<name>Pacific Time</name>

<stdShortName>PST</stdShortName>

<stdLongName>Pacific Standard Time</stdLongName>

<dstShortName>PDT</dstShortName>

<dstLongName>Pacific Daylight Saving Time</dstLongName>

</timeZone>

<obeyDst>false</obeyDst>

<lockedOut>false</lockedOut>

<forcePwdReset>true</forcePwdReset>

</User>

<User>

<id>WIENCKOSKI</id>

<qspInstance>1</QSPinstance>

<companyId>MYCOMPANY</companyId>

<firstName>Jesse</firstName>

<lastName>Wienckoski</lastName>

<role>

<name>User</name>

<description>General User</description>

</role>

<email>wienckoski@mycompany.com</email>

<pagerEmail>jesse@mycompany.com</pagerEmail>

<timeZone>

<gmtOffset>GMT-05:00</gmtOffset>

<name>Eastern Time</name>

<stdShortName>EST</stdShortName>

<stdLongName>Eastern Standard Time</stdLongName>

<dstShortName>EDT</dstShortName>

<dstLongName>Eastern Daylight Saving Time</dstLongName>

</timeZone>

<obeyDst>false</obeyDst>

<lockedOut>false</lockedOut>

<forcePwdReset>true</forcePwdReset>

</User>

</getUsersReturn>

</getUsersResponse>

</soapenv:Body>

Exceptions

001 Unknown Error.
003 Company not authorized for integration.
004 User not authorized.
005 Company ID is invalid.
006 Entity Type is invalid.
007 Entity Id is invalid.
008 Company is not licensed for requested application.
009 No users found.