Billhighway Cloud API

<back to all web services

MemberExternalIdCollection

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

public class MemberExternalIdCollection : Codable
{
    public var members:[MemberExternalId] = []

    required public init(){}
}

public class MemberExternalId : Codable
{
    public var uniqueId:String?
    public var clientId:Int?
    public var groupId:String?
    public var userId:String?
    public var bhUserId:Int?

    required public init(){}
}

public class MemberExternalIdReplyCollection : IHaveErrorField, Codable
{
    public var memberReply:[MemberExternalIdReply] = []
    public var isError:Bool?

    required public init(){}
}

public class MemberExternalIdReply : Codable
{
    public var uniqueId:String?
    public var userId:String?
    public var bhUserId:Int?
    public var errorCode:Int?
    public var errorMessage:String?

    required public init(){}
}


Swift 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
}