Billhighway Cloud API

<back to all web services

MemberExternalIdCollection

The following routes are available for this service:
POST/members/externalid
MemberExternalIdCollection Parameters:
NameParameterData TypeRequiredDescription
MembersbodyList<MemberExternalId>No
MemberExternalId Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
BhUserIdformintNo
MemberExternalIdReplyCollection Parameters:
NameParameterData TypeRequiredDescription
MemberReplyformList<MemberExternalIdReply>No
IsErrorformboolNo
MemberExternalIdReply Parameters:
NameParameterData TypeRequiredDescription
UniqueIdformstringNo
UserIdformstringNo
BhUserIdformintNo
ErrorCodeformintNo
ErrorMessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

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

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