Billhighway Cloud API

<back to all web services

MemberCollection

The following routes are available for this service:
POST/members
MemberCollection Parameters:
NameParameterData TypeRequiredDescription
MembersbodyList<Member>No
Member Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
AlternateUserIdformstringNo
BhUserIdformintNo
FirstNameformstringNo
LastNameformstringNo
MiddleNameformstringNo
PreferredEmailAddressformstringNo
OtherEmailAddressformstringNo
PreferredPhoneNumberformstringNo
PreferredAddress1formstringNo
PreferredAddress2formstringNo
PreferredCityformstringNo
PreferredStateformstringNo
PreferredZipformstringNo
PreferredCountryformstringNo
AccessLevelformstringNo
MemberStatusformstringNo
MemberTypeClientformstringNo
BillingTypeformstringNo
FiscalYearformintNo
WorkLocationformstringNo
DOBformDateTimeNo
PaperlessformstringNo
DisplayNameformstringNo
DisableLoginformstringNo
RecurringInvoiceSettingsformRecurringInvoiceSettingsNo
FormFieldsformList<SubscriberFormField>No
AttributesformList<AttributeItem>No
GroupListformList<Chapter>No
RecurringInvoiceSettings Parameters:
NameParameterData TypeRequiredDescription
DonationAmountformstringNo
SubscriberFormField Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
AttributeItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
Chapter Parameters:
NameParameterData TypeRequiredDescription
GroupIdformstringNo
MemberReplyCollection Parameters:
NameParameterData TypeRequiredDescription
MemberReplyformList<MemberReply>No
IsErrorformboolNo
MemberReply Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
ErrorCodeformintNo
ErrorMessageformstringNo
BillhighwayuserIdformintNo
UserIdformstringNo
GroupIdformstringNo

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>