Billhighway Cloud API

<back to all web services

MemberCollection

The following routes are available for this service:
POST/members
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class MemberCollection
    {
        public ArrayList<Member> Members = null;
        
        public ArrayList<Member> getMembers() { return Members; }
        public MemberCollection setMembers(ArrayList<Member> value) { this.Members = value; return this; }
    }

    public static class Member
    {
        public String ClassName = null;
        public String UniqueId = null;
        public Date CreatedDateTime = null;
        public Integer ClientId = null;
        public String GroupId = null;
        public String UserId = null;
        public String AlternateUserId = null;
        public Integer BhUserId = null;
        public String FirstName = null;
        public String LastName = null;
        public String MiddleName = null;
        public String PreferredEmailAddress = null;
        public String OtherEmailAddress = null;
        public String PreferredPhoneNumber = null;
        public String PreferredAddress1 = null;
        public String PreferredAddress2 = null;
        public String PreferredCity = null;
        public String PreferredState = null;
        public String PreferredZip = null;
        public String PreferredCountry = null;
        public String AccessLevel = null;
        public String MemberStatus = null;
        public String MemberTypeClient = null;
        public String BillingType = null;
        public Integer FiscalYear = null;
        public String WorkLocation = null;
        public Date DOB = null;
        public String Paperless = null;
        public String DisplayName = null;
        public String DisableLogin = null;
        public RecurringInvoiceSettings RecurringInvoiceSettings = null;
        public ArrayList<SubscriberFormField> FormFields = null;
        public ArrayList<AttributeItem> Attributes = null;
        public ArrayList<Chapter> GroupList = null;
        
        public String getClassName() { return ClassName; }
        public Member setClassName(String value) { this.ClassName = value; return this; }
        public String getUniqueId() { return UniqueId; }
        public Member setUniqueId(String value) { this.UniqueId = value; return this; }
        public Date getCreatedDateTime() { return CreatedDateTime; }
        public Member setCreatedDateTime(Date value) { this.CreatedDateTime = value; return this; }
        public Integer getClientId() { return ClientId; }
        public Member setClientId(Integer value) { this.ClientId = value; return this; }
        public String getGroupId() { return GroupId; }
        public Member setGroupId(String value) { this.GroupId = value; return this; }
        public String getUserId() { return UserId; }
        public Member setUserId(String value) { this.UserId = value; return this; }
        public String getAlternateUserId() { return AlternateUserId; }
        public Member setAlternateUserId(String value) { this.AlternateUserId = value; return this; }
        public Integer getBhUserId() { return BhUserId; }
        public Member setBhUserId(Integer value) { this.BhUserId = value; return this; }
        public String getFirstName() { return FirstName; }
        public Member setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public Member setLastName(String value) { this.LastName = value; return this; }
        public String getMiddleName() { return MiddleName; }
        public Member setMiddleName(String value) { this.MiddleName = value; return this; }
        public String getPreferredEmailAddress() { return PreferredEmailAddress; }
        public Member setPreferredEmailAddress(String value) { this.PreferredEmailAddress = value; return this; }
        public String getOtherEmailAddress() { return OtherEmailAddress; }
        public Member setOtherEmailAddress(String value) { this.OtherEmailAddress = value; return this; }
        public String getPreferredPhoneNumber() { return PreferredPhoneNumber; }
        public Member setPreferredPhoneNumber(String value) { this.PreferredPhoneNumber = value; return this; }
        public String getPreferredAddress1() { return PreferredAddress1; }
        public Member setPreferredAddress1(String value) { this.PreferredAddress1 = value; return this; }
        public String getPreferredAddress2() { return PreferredAddress2; }
        public Member setPreferredAddress2(String value) { this.PreferredAddress2 = value; return this; }
        public String getPreferredCity() { return PreferredCity; }
        public Member setPreferredCity(String value) { this.PreferredCity = value; return this; }
        public String getPreferredState() { return PreferredState; }
        public Member setPreferredState(String value) { this.PreferredState = value; return this; }
        public String getPreferredZip() { return PreferredZip; }
        public Member setPreferredZip(String value) { this.PreferredZip = value; return this; }
        public String getPreferredCountry() { return PreferredCountry; }
        public Member setPreferredCountry(String value) { this.PreferredCountry = value; return this; }
        public String getAccessLevel() { return AccessLevel; }
        public Member setAccessLevel(String value) { this.AccessLevel = value; return this; }
        public String getMemberStatus() { return MemberStatus; }
        public Member setMemberStatus(String value) { this.MemberStatus = value; return this; }
        public String getMemberTypeClient() { return MemberTypeClient; }
        public Member setMemberTypeClient(String value) { this.MemberTypeClient = value; return this; }
        public String getBillingType() { return BillingType; }
        public Member setBillingType(String value) { this.BillingType = value; return this; }
        public Integer getFiscalYear() { return FiscalYear; }
        public Member setFiscalYear(Integer value) { this.FiscalYear = value; return this; }
        public String getWorkLocation() { return WorkLocation; }
        public Member setWorkLocation(String value) { this.WorkLocation = value; return this; }
        public Date getDob() { return DOB; }
        public Member setDob(Date value) { this.DOB = value; return this; }
        public String getPaperless() { return Paperless; }
        public Member setPaperless(String value) { this.Paperless = value; return this; }
        public String getDisplayName() { return DisplayName; }
        public Member setDisplayName(String value) { this.DisplayName = value; return this; }
        public String getDisableLogin() { return DisableLogin; }
        public Member setDisableLogin(String value) { this.DisableLogin = value; return this; }
        public RecurringInvoiceSettings getRecurringInvoiceSettings() { return RecurringInvoiceSettings; }
        public Member setRecurringInvoiceSettings(RecurringInvoiceSettings value) { this.RecurringInvoiceSettings = value; return this; }
        public ArrayList<SubscriberFormField> getFormFields() { return FormFields; }
        public Member setFormFields(ArrayList<SubscriberFormField> value) { this.FormFields = value; return this; }
        public ArrayList<AttributeItem> getAttributes() { return Attributes; }
        public Member setAttributes(ArrayList<AttributeItem> value) { this.Attributes = value; return this; }
        public ArrayList<Chapter> getGroupList() { return GroupList; }
        public Member setGroupList(ArrayList<Chapter> value) { this.GroupList = value; return this; }
    }

    public static class RecurringInvoiceSettings
    {
        public String DonationAmount = null;
        
        public String getDonationAmount() { return DonationAmount; }
        public RecurringInvoiceSettings setDonationAmount(String value) { this.DonationAmount = value; return this; }
    }

    public static class SubscriberFormField
    {
        public String Name = null;
        public String Value = null;
        
        public String getName() { return Name; }
        public SubscriberFormField setName(String value) { this.Name = value; return this; }
        public String getValue() { return Value; }
        public SubscriberFormField setValue(String value) { this.Value = value; return this; }
    }

    public static class AttributeItem
    {
        public String Name = null;
        public String Value = null;
        
        public String getName() { return Name; }
        public AttributeItem setName(String value) { this.Name = value; return this; }
        public String getValue() { return Value; }
        public AttributeItem setValue(String value) { this.Value = value; return this; }
    }

    public static class Chapter
    {
        public String GroupId = null;
        
        public String getGroupId() { return GroupId; }
        public Chapter setGroupId(String value) { this.GroupId = value; return this; }
    }

    public static class MemberReplyCollection implements IHaveErrorField
    {
        public ArrayList<MemberReply> MemberReply = null;
        public Boolean IsError = null;
        
        public ArrayList<MemberReply> getMemberReply() { return MemberReply; }
        public MemberReplyCollection setMemberReply(ArrayList<MemberReply> value) { this.MemberReply = value; return this; }
        public Boolean getIsError() { return IsError; }
        public MemberReplyCollection setIsError(Boolean value) { this.IsError = value; return this; }
    }

    public static class MemberReply
    {
        public String ClassName = null;
        public String UniqueId = null;
        public Date CreatedDateTime = null;
        public Integer ClientId = null;
        public Integer ErrorCode = null;
        public String ErrorMessage = null;
        public Integer BillhighwayuserId = null;
        public String UserId = null;
        public String GroupId = null;
        
        public String getClassName() { return ClassName; }
        public MemberReply setClassName(String value) { this.ClassName = value; return this; }
        public String getUniqueId() { return UniqueId; }
        public MemberReply setUniqueId(String value) { this.UniqueId = value; return this; }
        public Date getCreatedDateTime() { return CreatedDateTime; }
        public MemberReply setCreatedDateTime(Date value) { this.CreatedDateTime = value; return this; }
        public Integer getClientId() { return ClientId; }
        public MemberReply setClientId(Integer value) { this.ClientId = value; return this; }
        public Integer getErrorCode() { return ErrorCode; }
        public MemberReply setErrorCode(Integer value) { this.ErrorCode = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public MemberReply setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public Integer getBillhighwayuserId() { return BillhighwayuserId; }
        public MemberReply setBillhighwayuserId(Integer value) { this.BillhighwayuserId = value; return this; }
        public String getUserId() { return UserId; }
        public MemberReply setUserId(String value) { this.UserId = value; return this; }
        public String getGroupId() { return GroupId; }
        public MemberReply setGroupId(String value) { this.GroupId = value; return this; }
    }

}

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