Billhighway Cloud API

<back to all web services

MemberCollection

The following routes are available for this service:
POST/members
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.SalesForce
Imports BH.CloudAPI.Common.DTO.Member
Imports BH.CloudAPI.Common4.DTO
Imports BH.CloudAPI.Common.DTO

Namespace Global

    Namespace BH.CloudAPI.Common.DTO

        Public Partial Class Chapter
            Public Overridable Property GroupId As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common.DTO.Member

        Public Partial Class RecurringInvoiceSettings
            Public Overridable Property DonationAmount As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO

        Public Partial Class AttributeItem
            Public Overridable Property Name As String
            Public Overridable Property Value As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.SalesForce

        Public Partial Class Member
            Public Sub New()
                FormFields = New List(Of SubscriberFormField)
                Attributes = New List(Of AttributeItem)
                GroupList = New List(Of Chapter)
            End Sub

            Public Overridable Property ClassName As String
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property GroupId As String
            Public Overridable Property UserId As String
            Public Overridable Property AlternateUserId As String
            Public Overridable Property BhUserId As Integer
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property MiddleName As String
            Public Overridable Property PreferredEmailAddress As String
            Public Overridable Property OtherEmailAddress As String
            Public Overridable Property PreferredPhoneNumber As String
            Public Overridable Property PreferredAddress1 As String
            Public Overridable Property PreferredAddress2 As String
            Public Overridable Property PreferredCity As String
            Public Overridable Property PreferredState As String
            Public Overridable Property PreferredZip As String
            Public Overridable Property PreferredCountry As String
            Public Overridable Property AccessLevel As String
            Public Overridable Property MemberStatus As String
            Public Overridable Property MemberTypeClient As String
            Public Overridable Property BillingType As String
            Public Overridable Property FiscalYear As Integer
            Public Overridable Property WorkLocation As String
            Public Overridable Property DOB As Date
            Public Overridable Property Paperless As String
            Public Overridable Property DisplayName As String
            Public Overridable Property DisableLogin As String
            Public Overridable Property RecurringInvoiceSettings As RecurringInvoiceSettings
            Public Overridable Property FormFields As List(Of SubscriberFormField)
            Public Overridable Property Attributes As List(Of AttributeItem)
            Public Overridable Property GroupList As List(Of Chapter)
        End Class

        Public Partial Class MemberCollection
            Public Sub New()
                Members = New List(Of Member)
            End Sub

            Public Overridable Property Members As List(Of Member)
        End Class

        Public Partial Class MemberReply
            Public Overridable Property ClassName As String
            Public Overridable Property UniqueId As String
            Public Overridable Property CreatedDateTime As Date
            Public Overridable Property ClientId As Integer
            Public Overridable Property ErrorCode As Integer
            Public Overridable Property ErrorMessage As String
            Public Overridable Property BillhighwayuserId As Integer
            Public Overridable Property UserId As String
            Public Overridable Property GroupId As String
        End Class

        Public Partial Class MemberReplyCollection
            Implements IHaveErrorField
            Public Sub New()
                MemberReply = New List(Of MemberReply)
            End Sub

            Public Overridable Property MemberReply As List(Of MemberReply)
            Public Overridable Property IsError As Boolean
        End Class

        Public Partial Class SubscriberFormField
            Public Overridable Property Name As String
            Public Overridable Property Value As String
        End Class
    End Namespace
End Namespace

VB.NET MemberCollection 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 HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MemberCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <Members>
    <Member>
      <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>
    </Member>
  </Members>
</MemberCollection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MemberReplyCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <MemberReply>
    <MemberReply>
      <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>
    </MemberReply>
  </MemberReply>
</MemberReplyCollection>