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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Members: 
	[
		{
			UniqueId: String,
			ClientId: 0,
			GroupId: String,
			UserId: String,
			BhUserId: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MemberReply: 
	[
		{
			UniqueId: String,
			UserId: String,
			BhUserId: 0,
			ErrorCode: 0,
			ErrorMessage: String
		}
	],
	IsError: False
}