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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserInformation:
    bh_support_email: Optional[str] = None
    bh_support_phone: Optional[str] = None
    bhivr_phone: Optional[str] = None
    id: Optional[int] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    display_name: Optional[str] = None
    email_address: Optional[str] = None
    affiliation_name: Optional[str] = None
    group_id: Optional[int] = None
    group_name: Optional[str] = None
    group_nickname: Optional[str] = None
    client_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUser(GetUser, IReturnLegacyException):
    pass

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