Billhighway Cloud API

<back to all web services

MemberSubscriptionCollection

The following routes are available for this service:
POST/subscription
namespace BH.CloudAPI.Common4.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MemberSubscription() = 
        member val UniqueId:String = null with get,set
        member val ClientId:Int32 = new Int32() with get,set
        member val GroupId:String = null with get,set
        member val UserID:String = null with get,set
        member val ClientCompanyID:String = null with get,set
        member val ClientOrderID:Int64 = new Int64() with get,set
        member val ClientMemberSubscriberID:Int64 = new Int64() with get,set
        member val ClientSubscriptionTemplate:String = null with get,set
        member val SubscriptionID:Int64 = new Int64() with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type MemberSubscriptionCollection() = 
        member val MemberSubscriptions:ResizeArray<MemberSubscription> = new ResizeArray<MemberSubscription>() with get,set

    [<AllowNullLiteral>]
    type MemberSubscriptionReply() = 
        member val UniqueId:String = null with get,set
        member val ClientId:Int32 = new Int32() with get,set
        member val MemberSubscriptionInvoiceId:Int32 = new Int32() with get,set
        member val ErrorCode:Int32 = new Int32() with get,set
        member val ErrorMessage:String = null with get,set

    [<AllowNullLiteral>]
    type MemberSubscriptionReplyCollection() = 
        member val MemberSubscriptionReply:ResizeArray<MemberSubscriptionReply> = new ResizeArray<MemberSubscriptionReply>() with get,set
        member val IsError:Boolean = new Boolean() with get,set

F# 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
}