POST User/getusers
Get list of users including their dealsheet access code.
Request Information
URI Parameters
None.
Body Parameters
GetUsersRequestName | Description | Type | Additional information |
---|---|---|---|
refreshAccessCodes |
Refresh Access Codes |
boolean |
None. |
token |
API access token |
globally unique identifier |
Required |
Request Formats
application/json, text/json
Sample:
{ "refreshAccessCodes": true, "token": "6d90872f-0d0e-458f-a185-48f14f22c556" }
application/xml, text/xml
Sample:
<GetUsersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.User"> <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">6d90872f-0d0e-458f-a185-48f14f22c556</token> <refreshAccessCodes>true</refreshAccessCodes> </GetUsersRequest>
Response Information
Resource Description
GetUsersResponseName | Description | Type | Additional information |
---|---|---|---|
code |
API result code |
integer |
None. |
error |
API error message |
string |
None. |
UserList |
User list |
Collection of UserItem |
None. |
APIVersion |
API Version |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "UserList": [ { "UserID": 1, "UserName": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "Email": "sample string 5", "AccessCode": "sample string 6", "AccessCodeExpirationDate": "2024-12-08T01:46:22.685408-08:00", "LoginDuration": "sample string 8" }, { "UserID": 1, "UserName": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "Email": "sample string 5", "AccessCode": "sample string 6", "AccessCodeExpirationDate": "2024-12-08T01:46:22.685408-08:00", "LoginDuration": "sample string 8" } ], "APIVersion": 1, "code": 200, "error": "sample string 1" }
application/xml, text/xml
Sample:
<GetUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.User"> <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">1</APIVersion> <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error> <UserList> <UserItem> <AccessCode>sample string 6</AccessCode> <AccessCodeExpirationDate>2024-12-08T01:46:22.685408-08:00</AccessCodeExpirationDate> <Email>sample string 5</Email> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <LoginDuration>sample string 8</LoginDuration> <UserID>1</UserID> <UserName>sample string 2</UserName> </UserItem> <UserItem> <AccessCode>sample string 6</AccessCode> <AccessCodeExpirationDate>2024-12-08T01:46:22.685408-08:00</AccessCodeExpirationDate> <Email>sample string 5</Email> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <LoginDuration>sample string 8</LoginDuration> <UserID>1</UserID> <UserName>sample string 2</UserName> </UserItem> </UserList> </GetUsersResponse>