The following service is useful to query information about users.
GetUser
This service is used to query the User object.
Request Parameters
Node |
Required |
Data Type |
Description |
userID |
Yes |
Integer |
The object identifier. |
Return Data
Node |
Data Type |
Description |
user |
XML |
|
affiliateID |
Integer |
|
createdByUserID |
Integer |
|
createdOnDate |
DateTime |
|
displayName |
String |
|
email |
String |
|
firstName |
String |
|
isSuperUser |
Boolean |
|
lastIPAddress |
String |
|
lastName |
String |
|
portalID |
Integer |
|
roles |
String |
|
userID |
Integer |
|
username |
String |
|
GetUsers
This service is used to query all the user objects.
Request Parameters
Node |
Required |
Data Type |
Description |
count |
No |
Boolean |
Specify if return data should include total number of records found. |
skip |
No |
Integer |
The number of records to skip over for paging purposes. |
take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
Node |
Data Type |
Description |
totalCount |
Integer |
Number of records found. |
users |
XML |
Container node |
user |
XML |
Zero or more User nodes with same data structure as GetUser service return data. |
GetUsersByCreatedDate
This service is used to query all the user objects by the created date range.
Request Parameters
Node |
Required |
Data Type |
Description |
count |
No |
Boolean |
Specify if return data should include total number of records found. |
skip |
No |
Integer |
The number of records to skip over for paging purposes. |
startDate |
Yes |
DateTime |
|
stopDate |
Yes |
DateTime |
|
take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
Node |
Data Type |
Description |
totalCount |
Integer |
Number of records found. |
users |
XML |
Container node |
user |
XML |
Zero or more User nodes with same data structure as GetUser service return data. |
GetUsersByLastModifiedDate
This service is used to query all the user objects by the last modified date range.
Request Parameters
Node |
Required |
Data Type |
Description |
count |
No |
Boolean |
Specify if return data should include total number of records found. |
skip |
No |
Integer |
The number of records to skip over for paging purposes. |
startDate |
Yes |
DateTime |
|
stopDate |
Yes |
DateTime |
|
take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
Node |
Data Type |
Description |
totalCount |
Integer |
Number of records found. |
users |
XML |
Container node |
user |
XML |
Zero or more User nodes with same data structure as GetUser service return data.
|