Billhighway Cloud API

<back to all web services

MemberSubscriptionCollection

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

public class MemberSubscriptionCollection : Codable
{
    public var memberSubscriptions:[MemberSubscription] = []

    required public init(){}
}

public class MemberSubscription : Codable
{
    public var uniqueId:String?
    public var clientId:Int?
    public var groupId:String?
    public var userID:String?
    public var clientCompanyID:String?
    public var clientOrderID:Int?
    public var clientMemberSubscriberID:Int?
    public var clientSubscriptionTemplate:String?
    public var subscriptionID:Int?
    public var startDate:Date?
    public var endDate:Date?

    required public init(){}
}

public class MemberSubscriptionReplyCollection : IHaveErrorField, Codable
{
    public var memberSubscriptionReply:[MemberSubscriptionReply] = []
    public var isError:Bool?

    required public init(){}
}

public class MemberSubscriptionReply : Codable
{
    public var uniqueId:String?
    public var clientId:Int?
    public var memberSubscriptionInvoiceId:Int?
    public var errorCode:Int?
    public var errorMessage:String?

    required public init(){}
}


Swift MemberSubscriptionCollection 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 /subscription HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MemberSubscriptions: 
	[
		{
			UniqueId: String,
			ClientId: 0,
			GroupId: String,
			UserID: String,
			ClientCompanyID: String,
			ClientOrderID: 0,
			ClientMemberSubscriberID: 0,
			ClientSubscriptionTemplate: String,
			SubscriptionID: 0,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MemberSubscriptionReply: 
	[
		{
			UniqueId: String,
			ClientId: 0,
			MemberSubscriptionInvoiceId: 0,
			ErrorCode: 0,
			ErrorMessage: String
		}
	],
	IsError: False
}