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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	BHSupportEmail: support@billhighway.com,
	BHSupportPhone: 866-245-5499,
	BHIVRPhone: 877-336-6007,
	Id: 0,
	FirstName: String,
	LastName: String,
	DisplayName: "String, String",
	EmailAddress: String,
	AffiliationName: String,
	GroupId: 0,
	GroupName: String,
	GroupNickname: String,
	ClientId: 0
}