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

export class UserInformation
{
    public BHSupportEmail?: string;
    public BHSupportPhone?: string;
    public BHIVRPhone?: string;
    public Id?: number;
    public FirstName?: string;
    public LastName?: string;
    public DisplayName?: string;
    public EmailAddress?: string;
    public AffiliationName?: string;
    public GroupId?: number;
    public GroupName?: string;
    public GroupNickname?: string;
    public ClientId?: number;

    public constructor(init?: Partial<UserInformation>) { (Object as any).assign(this, init); }
}

export class GetUser extends GetUser implements IReturnLegacyException
{

    public constructor(init?: Partial<GetUser>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>