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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO;
using BH.CloudAPI.Common.Models;

namespace BH.CloudAPI.Common.Models
{
    public partial class UserInformation
    {
        public virtual string BHSupportEmail { get; set; }
        public virtual string BHSupportPhone { get; set; }
        public virtual string BHIVRPhone { get; set; }
        public virtual int Id { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual string EmailAddress { get; set; }
        public virtual string AffiliationName { get; set; }
        public virtual int GroupId { get; set; }
        public virtual string GroupName { get; set; }
        public virtual string GroupNickname { get; set; }
        public virtual int? ClientId { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO
{
    public partial class GetUser
        : GetUser, IReturnLegacyException
    {
    }

}

C# 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>