Billhighway Cloud API

<back to all web services

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"Members":[{"UniqueId":"String","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"MemberReply":[{"UniqueId":"String","UserId":"String","BhUserId":0,"ErrorCode":0,"ErrorMessage":"String"}],"IsError":false}