Billhighway Cloud API

<back to all web services

MemberCollection

The following routes are available for this service:
POST/members
namespace BH.CloudAPI.Common.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MemberReply() = 
        member val ClassName:String = null with get,set
        member val UniqueId:String = null with get,set
        member val CreatedDateTime:DateTime = new DateTime() with get,set
        member val ClientId:Int32 = new Int32() with get,set
        member val ErrorCode:Int32 = new Int32() with get,set
        member val ErrorMessage:String = null with get,set
        member val BillhighwayuserId:Int32 = new Int32() with get,set
        member val UserId:String = null with get,set
        member val GroupId:String = null with get,set

    [<AllowNullLiteral>]
    type MemberReplyCollection() = 
        member val MemberReply:ResizeArray<MemberReply> = new ResizeArray<MemberReply>() with get,set
        member val IsError:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type RecurringInvoiceSettings() = 
        member val DonationAmount:String = null with get,set

    [<AllowNullLiteral>]
    type SubscriberFormField() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type AttributeItem() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type Chapter() = 
        member val GroupId:String = null with get,set

    [<AllowNullLiteral>]
    type Member() = 
        member val ClassName:String = null with get,set
        member val UniqueId:String = null with get,set
        member val CreatedDateTime:DateTime = new DateTime() with get,set
        member val ClientId:Int32 = new Int32() with get,set
        member val GroupId:String = null with get,set
        member val UserId:String = null with get,set
        member val AlternateUserId:String = null with get,set
        member val BhUserId:Int32 = new Int32() with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val MiddleName:String = null with get,set
        member val PreferredEmailAddress:String = null with get,set
        member val OtherEmailAddress:String = null with get,set
        member val PreferredPhoneNumber:String = null with get,set
        member val PreferredAddress1:String = null with get,set
        member val PreferredAddress2:String = null with get,set
        member val PreferredCity:String = null with get,set
        member val PreferredState:String = null with get,set
        member val PreferredZip:String = null with get,set
        member val PreferredCountry:String = null with get,set
        member val AccessLevel:String = null with get,set
        member val MemberStatus:String = null with get,set
        member val MemberTypeClient:String = null with get,set
        member val BillingType:String = null with get,set
        member val FiscalYear:Int32 = new Int32() with get,set
        member val WorkLocation:String = null with get,set
        member val DOB:DateTime = new DateTime() with get,set
        member val Paperless:String = null with get,set
        member val DisplayName:String = null with get,set
        member val DisableLogin:String = null with get,set
        member val RecurringInvoiceSettings:RecurringInvoiceSettings = null with get,set
        member val FormFields:ResizeArray<SubscriberFormField> = new ResizeArray<SubscriberFormField>() with get,set
        member val Attributes:ResizeArray<AttributeItem> = new ResizeArray<AttributeItem>() with get,set
        member val GroupList:ResizeArray<Chapter> = new ResizeArray<Chapter>() with get,set

    [<AllowNullLiteral>]
    type MemberCollection() = 
        member val Members:ResizeArray<Member> = new ResizeArray<Member>() with get,set

F# 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>