Billhighway Cloud API

MemberExternalIdCollection

The following routes are available for this service:
POST	/members/externalid

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 MemberExternalId:
    unique_id: Optional[str] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberExternalIdCollection:
    members: Optional[List[MemberExternalId]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberExternalIdReply:
    unique_id: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberExternalIdReplyCollection(IHaveErrorField):
    member_reply: Optional[List[MemberExternalIdReply]] = None
    is_error: Optional[bool] = None

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

POST /members/externalid HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MemberExternalIdCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Services">
  <Members>
    <MemberExternalId>
      <BhUserId>0</BhUserId>
      <ClientId>0</ClientId>
      <GroupId>String</GroupId>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </MemberExternalId>
  </Members>
</MemberExternalIdCollection>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MemberExternalIdReplyCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Services">
  <MemberReply>
    <MemberExternalIdReply>
      <BhUserId>0</BhUserId>
      <ErrorCode>0</ErrorCode>
      <ErrorMessage>String</ErrorMessage>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </MemberExternalIdReply>
  </MemberReply>
</MemberExternalIdReplyCollection>