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 'package:servicestack/servicestack.dart';

class UserInformation implements IConvertible
{
    String? BHSupportEmail;
    String? BHSupportPhone;
    String? BHIVRPhone;
    int? Id;
    String? FirstName;
    String? LastName;
    String? DisplayName;
    String? EmailAddress;
    String? AffiliationName;
    int? GroupId;
    String? GroupName;
    String? GroupNickname;
    int? ClientId;

    UserInformation({this.BHSupportEmail,this.BHSupportPhone,this.BHIVRPhone,this.Id,this.FirstName,this.LastName,this.DisplayName,this.EmailAddress,this.AffiliationName,this.GroupId,this.GroupName,this.GroupNickname,this.ClientId});
    UserInformation.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BHSupportEmail = json['BHSupportEmail'];
        BHSupportPhone = json['BHSupportPhone'];
        BHIVRPhone = json['BHIVRPhone'];
        Id = json['Id'];
        FirstName = json['FirstName'];
        LastName = json['LastName'];
        DisplayName = json['DisplayName'];
        EmailAddress = json['EmailAddress'];
        AffiliationName = json['AffiliationName'];
        GroupId = json['GroupId'];
        GroupName = json['GroupName'];
        GroupNickname = json['GroupNickname'];
        ClientId = json['ClientId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BHSupportEmail': BHSupportEmail,
        'BHSupportPhone': BHSupportPhone,
        'BHIVRPhone': BHIVRPhone,
        'Id': Id,
        'FirstName': FirstName,
        'LastName': LastName,
        'DisplayName': DisplayName,
        'EmailAddress': EmailAddress,
        'AffiliationName': AffiliationName,
        'GroupId': GroupId,
        'GroupName': GroupName,
        'GroupNickname': GroupNickname,
        'ClientId': ClientId
    };

    getTypeName() => "UserInformation";
    TypeContext? context = _ctx;
}

class GetUser extends GetUser implements IReturnLegacyException, IConvertible
{
    GetUser();
    GetUser.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "GetUser";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'UserInformation': TypeInfo(TypeOf.Class, create:() => UserInformation()),
    'GetUser': TypeInfo(TypeOf.Class, create:() => GetUser()),
});

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