Billhighway Cloud API

<back to all web services

GetUser

The following routes are available for this service:
GET/v1.1/users/get
GET/v1.2/users/get
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetUser extends GetUser implements IReturnLegacyException
    {
        
    }

    public static class UserInformation
    {
        public String BHSupportEmail = null;
        public String BHSupportPhone = null;
        public String BHIVRPhone = null;
        public Integer Id = null;
        public String FirstName = null;
        public String LastName = null;
        public String DisplayName = null;
        public String EmailAddress = null;
        public String AffiliationName = null;
        public Integer GroupId = null;
        public String GroupName = null;
        public String GroupNickname = null;
        public Integer ClientId = null;
        
        public String getBhSupportEmail() { return BHSupportEmail; }
        public UserInformation setBhSupportEmail(String value) { this.BHSupportEmail = value; return this; }
        public String getBhSupportPhone() { return BHSupportPhone; }
        public UserInformation setBhSupportPhone(String value) { this.BHSupportPhone = value; return this; }
        public String getBhivrPhone() { return BHIVRPhone; }
        public UserInformation setBhivrPhone(String value) { this.BHIVRPhone = value; return this; }
        public Integer getId() { return Id; }
        public UserInformation setId(Integer value) { this.Id = value; return this; }
        public String getFirstName() { return FirstName; }
        public UserInformation setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public UserInformation setLastName(String value) { this.LastName = value; return this; }
        public String getDisplayName() { return DisplayName; }
        public UserInformation setDisplayName(String value) { this.DisplayName = value; return this; }
        public String getEmailAddress() { return EmailAddress; }
        public UserInformation setEmailAddress(String value) { this.EmailAddress = value; return this; }
        public String getAffiliationName() { return AffiliationName; }
        public UserInformation setAffiliationName(String value) { this.AffiliationName = value; return this; }
        public Integer getGroupId() { return GroupId; }
        public UserInformation setGroupId(Integer value) { this.GroupId = value; return this; }
        public String getGroupName() { return GroupName; }
        public UserInformation setGroupName(String value) { this.GroupName = value; return this; }
        public String getGroupNickname() { return GroupNickname; }
        public UserInformation setGroupNickname(String value) { this.GroupNickname = value; return this; }
        public Integer getClientId() { return ClientId; }
        public UserInformation setClientId(Integer value) { this.ClientId = value; return this; }
    }

}

Java GetUser DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>