Billhighway Cloud API

<back to all web services

MemberExternalIdCollection

The following routes are available for this service:
POST/members/externalid

export class MemberExternalId
{
    public UniqueId?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public BhUserId?: number;

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

export class MemberExternalIdCollection
{
    public Members?: MemberExternalId[];

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

export class MemberExternalIdReply
{
    public UniqueId?: string;
    public UserId?: string;
    public BhUserId?: number;
    public ErrorCode?: number;
    public ErrorMessage?: string;

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

export class MemberExternalIdReplyCollection implements IHaveErrorField
{
    public MemberReply?: MemberExternalIdReply[];
    public IsError?: boolean;

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

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

<MemberExternalIdCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Services">
  <Members>
    <MemberExternalId>
      <BhUserId>0</BhUserId>
      <ClientId>0</ClientId>
      <GroupId>String</GroupId>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </MemberExternalId>
  </Members>
</MemberExternalIdCollection>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MemberExternalIdReplyCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Services">
  <MemberReply>
    <MemberExternalIdReply>
      <BhUserId>0</BhUserId>
      <ErrorCode>0</ErrorCode>
      <ErrorMessage>String</ErrorMessage>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </MemberExternalIdReply>
  </MemberReply>
</MemberExternalIdReplyCollection>