Billhighway Cloud API

SalesForceMemberCollection

The following routes are available for this service:
POST	/api/SalesForce/Member

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 SalesForceMemberReply:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None
    billhighwayuser_id: Optional[int] = None
    user_id: Optional[str] = None
    group_id: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringInvoiceSettings:
    donation_amount: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriberFormField:
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AttributeItem:
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Chapter:
    group_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceMember:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    alternate_user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    middle_name: Optional[str] = None
    preferred_email_address: Optional[str] = None
    other_email_address: Optional[str] = None
    preferred_phone_number: Optional[str] = None
    preferred_address1: Optional[str] = None
    preferred_address2: Optional[str] = None
    preferred_city: Optional[str] = None
    preferred_state: Optional[str] = None
    preferred_zip: Optional[str] = None
    preferred_country: Optional[str] = None
    access_level: Optional[str] = None
    member_status: Optional[str] = None
    member_type_client: Optional[str] = None
    billing_type: Optional[str] = None
    fiscal_year: Optional[int] = None
    work_location: Optional[str] = None
    dob: Optional[datetime.datetime] = None
    paperless: Optional[str] = None
    display_name: Optional[str] = None
    disable_login: Optional[str] = None
    recurring_invoice_settings: Optional[RecurringInvoiceSettings] = None
    form_fields: Optional[List[SubscriberFormField]] = None
    attributes: Optional[List[AttributeItem]] = None
    group_list: Optional[List[Chapter]] = None


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

Python SalesForceMemberCollection 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 /api/SalesForce/Member HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SalesForceMemberCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <Members>
    <SalesForceMember>
      <AccessLevel>String</AccessLevel>
      <AlternateUserId>String</AlternateUserId>
      <Attributes xmlns:d4p1="https://www.billhighway.com/api">
        <d4p1:AttributeItem>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:AttributeItem>
      </Attributes>
      <BhUserId>0</BhUserId>
      <BillingType>String</BillingType>
      <ClassName>String</ClassName>
      <ClientId>0</ClientId>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <DOB>0001-01-01T00:00:00</DOB>
      <DisableLogin>String</DisableLogin>
      <DisplayName>String</DisplayName>
      <FirstName>String</FirstName>
      <FiscalYear>0</FiscalYear>
      <FormFields>
        <SubscriberFormField>
          <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
          <_x003C_Value_x003E_k__BackingField>String</_x003C_Value_x003E_k__BackingField>
        </SubscriberFormField>
      </FormFields>
      <GroupId>String</GroupId>
      <GroupList xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
        <d4p1:Chapter>
          <d4p1:GroupId>String</d4p1:GroupId>
        </d4p1:Chapter>
      </GroupList>
      <LastName>String</LastName>
      <MemberStatus>String</MemberStatus>
      <MemberTypeClient>String</MemberTypeClient>
      <MiddleName>String</MiddleName>
      <OtherEmailAddress>String</OtherEmailAddress>
      <Paperless>String</Paperless>
      <PreferredAddress1>String</PreferredAddress1>
      <PreferredAddress2>String</PreferredAddress2>
      <PreferredCity>String</PreferredCity>
      <PreferredCountry>String</PreferredCountry>
      <PreferredEmailAddress>String</PreferredEmailAddress>
      <PreferredPhoneNumber>String</PreferredPhoneNumber>
      <PreferredState>String</PreferredState>
      <PreferredZip>String</PreferredZip>
      <RecurringInvoiceSettings xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.Member">
        <d4p1:DonationAmount>String</d4p1:DonationAmount>
      </RecurringInvoiceSettings>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
      <WorkLocation>String</WorkLocation>
    </SalesForceMember>
  </Members>
</SalesForceMemberCollection>

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

<SalesForceMemberReplyCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <MemberReply>
    <SalesForceMemberReply>
      <BillhighwayuserId>0</BillhighwayuserId>
      <ClassName>String</ClassName>
      <ClientId>0</ClientId>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <ErrorCode>0</ErrorCode>
      <ErrorMessage>String</ErrorMessage>
      <GroupId>String</GroupId>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </SalesForceMemberReply>
  </MemberReply>
</SalesForceMemberReplyCollection>