Billhighway Cloud API

<back to all web services

SalesForceMemberCollection

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

export class SalesForceMemberReply
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public ErrorCode?: number;
    public ErrorMessage?: string;
    public BillhighwayuserId?: number;
    public UserId?: string;
    public GroupId?: string;

    public constructor(init?: Partial<SalesForceMemberReply>) { (Object as any).assign(this, init); }
}

export class SalesForceMemberReplyCollection implements IHaveErrorField
{
    public MemberReply?: SalesForceMemberReply[];
    public IsError?: boolean;

    public constructor(init?: Partial<SalesForceMemberReplyCollection>) { (Object as any).assign(this, init); }
}

export class RecurringInvoiceSettings
{
    public DonationAmount?: string;

    public constructor(init?: Partial<RecurringInvoiceSettings>) { (Object as any).assign(this, init); }
}

export class SubscriberFormField
{
    public Name?: string;
    public Value?: string;

    public constructor(init?: Partial<SubscriberFormField>) { (Object as any).assign(this, init); }
}

export class AttributeItem
{
    public Name?: string;
    public Value?: string;

    public constructor(init?: Partial<AttributeItem>) { (Object as any).assign(this, init); }
}

export class Chapter
{
    public GroupId?: string;

    public constructor(init?: Partial<Chapter>) { (Object as any).assign(this, init); }
}

export class SalesForceMember
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public AlternateUserId?: string;
    public BhUserId?: number;
    public FirstName?: string;
    public LastName?: string;
    public MiddleName?: string;
    public PreferredEmailAddress?: string;
    public OtherEmailAddress?: string;
    public PreferredPhoneNumber?: string;
    public PreferredAddress1?: string;
    public PreferredAddress2?: string;
    public PreferredCity?: string;
    public PreferredState?: string;
    public PreferredZip?: string;
    public PreferredCountry?: string;
    public AccessLevel?: string;
    public MemberStatus?: string;
    public MemberTypeClient?: string;
    public BillingType?: string;
    public FiscalYear?: number;
    public WorkLocation?: string;
    public DOB?: string;
    public Paperless?: string;
    public DisplayName?: string;
    public DisableLogin?: string;
    public RecurringInvoiceSettings?: RecurringInvoiceSettings;
    public FormFields?: SubscriberFormField[];
    public Attributes?: AttributeItem[];
    public GroupList?: Chapter[];

    public constructor(init?: Partial<SalesForceMember>) { (Object as any).assign(this, init); }
}

export class SalesForceMemberCollection
{
    public Members?: SalesForceMember[];

    public constructor(init?: Partial<SalesForceMemberCollection>) { (Object as any).assign(this, init); }
}

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