| GET | /v1.1/users/get | ||
|---|---|---|---|
| GET | /v1.2/users/get |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BHSupportEmail | form | string | No | |
| BHSupportPhone | form | string | No | |
| BHIVRPhone | form | string | No | |
| Id | form | int | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| DisplayName | form | string | No | |
| EmailAddress | form | string | No | |
| AffiliationName | form | string | No | |
| GroupId | form | int | No | |
| GroupName | form | string | No | |
| GroupNickname | form | string | No | |
| ClientId | form | int? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1.1/users/get HTTP/1.1 Host: devapi.billhighway.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <UserInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.Models"> <AffiliationName>String</AffiliationName> <ClientId>0</ClientId> <EmailAddress>String</EmailAddress> <FirstName>String</FirstName> <GroupId>0</GroupId> <GroupName>String</GroupName> <GroupNickname>String</GroupNickname> <Id>0</Id> <LastName>String</LastName> </UserInformation>