GET api/v7/Users?alternateId={alternateId}
Get a user by alternate id
Request Information
URI Parameters
| Name | Description | Type | Required? | Additional information |
|---|---|---|---|---|
| alternateId * |
Alternate Id of a given user |
string |
Yes |
None. |
Body Parameters
None.
Response Information
Resource Description
Returns the user for the given alternate id
Complete User Information| Name | Description | Type |
|---|---|---|
| roles |
Roles of the user |
Collection of Role Information |
| active |
Flag denoting if user is active |
boolean |
| startDate |
Start Date of User Activity |
date |
| endDate |
End date of user activity |
date |
| contactInfo |
Contact Information of the User |
Contact Information |
| addressInfo |
Address Information of the User |
Address Information |
| userId |
User Id |
string |
| firstName |
First Name of the User |
string |
| lastName |
Last Name of the User |
string |
| displayName |
Preferred Display Name |
string |
| alternateId |
Alternate user Id |
string |
| primaryLanguage |
Primary Language of User |
string |
| secondaryLanguage |
Secondary Language of the User |
string |
| customerAuditDate |
Last modified audit information |
date |
Response Formats
application/json, text/json
Sample:
{
"active": false
}
application/xml, text/xml
Sample:
<User xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <customerAuditDate xsi:nil="true" /> <active>false</active> <startDate xsi:nil="true" /> <endDate xsi:nil="true" /> </User>