Billhighway Cloud API

MemberCollection

The following routes are available for this service:
POST	/members

namespace BH.CloudAPI.Common.DTO

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

    [<AllowNullLiteral>]
    type MemberReply() = 
        member val ClassName:String = null with get,set
        member val UniqueId:String = null with get,set
        member val CreatedDateTime:DateTime = new DateTime() with get,set
        member val ClientId:Int32 = new Int32() with get,set
        member val ErrorCode:Int32 = new Int32() with get,set
        member val ErrorMessage:String = null with get,set
        member val BillhighwayuserId:Int32 = new Int32() with get,set
        member val UserId:String = null with get,set
        member val GroupId:String = null with get,set

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

    [<AllowNullLiteral>]
    type RecurringInvoiceSettings() = 
        member val DonationAmount:String = null with get,set

    [<AllowNullLiteral>]
    type SubscriberFormField() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type AttributeItem() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type Chapter() = 
        member val GroupId:String = null with get,set

    [<AllowNullLiteral>]
    type Member() = 
        member val ClassName:String = null with get,set
        member val UniqueId:String = null with get,set
        member val CreatedDateTime:DateTime = new DateTime() 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 AlternateUserId:String = null with get,set
        member val BhUserId:Int32 = new Int32() with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val MiddleName:String = null with get,set
        member val PreferredEmailAddress:String = null with get,set
        member val OtherEmailAddress:String = null with get,set
        member val PreferredPhoneNumber:String = null with get,set
        member val PreferredAddress1:String = null with get,set
        member val PreferredAddress2:String = null with get,set
        member val PreferredCity:String = null with get,set
        member val PreferredState:String = null with get,set
        member val PreferredZip:String = null with get,set
        member val PreferredCountry:String = null with get,set
        member val AccessLevel:String = null with get,set
        member val MemberStatus:String = null with get,set
        member val MemberTypeClient:String = null with get,set
        member val BillingType:String = null with get,set
        member val FiscalYear:Int32 = new Int32() with get,set
        member val WorkLocation:String = null with get,set
        member val DOB:DateTime = new DateTime() with get,set
        member val Paperless:String = null with get,set
        member val DisplayName:String = null with get,set
        member val DisableLogin:String = null with get,set
        member val RecurringInvoiceSettings:RecurringInvoiceSettings = null with get,set
        member val FormFields:ResizeArray<SubscriberFormField> = new ResizeArray<SubscriberFormField>() with get,set
        member val Attributes:ResizeArray<AttributeItem> = new ResizeArray<AttributeItem>() with get,set
        member val GroupList:ResizeArray<Chapter> = new ResizeArray<Chapter>() with get,set

    [<AllowNullLiteral>]
    type MemberCollection() = 
        member val Members:ResizeArray<Member> = new ResizeArray<Member>() with get,set

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

{
	Members: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			ClientId: 0,
			GroupId: String,
			UserId: String,
			AlternateUserId: String,
			BhUserId: 0,
			FirstName: String,
			LastName: String,
			MiddleName: String,
			PreferredEmailAddress: String,
			OtherEmailAddress: String,
			PreferredPhoneNumber: String,
			PreferredAddress1: String,
			PreferredAddress2: String,
			PreferredCity: String,
			PreferredState: String,
			PreferredZip: String,
			PreferredCountry: String,
			AccessLevel: String,
			MemberStatus: String,
			MemberTypeClient: String,
			BillingType: String,
			FiscalYear: 0,
			WorkLocation: String,
			DOB: 0001-01-01,
			Paperless: String,
			DisplayName: String,
			DisableLogin: String,
			RecurringInvoiceSettings: 
			{
				DonationAmount: String
			},
			FormFields: 
			[
				{
					Name: String,
					Value: String
				}
			],
			Attributes: 
			[
				{
					Name: String,
					Value: String
				}
			],
			GroupList: 
			[
				{
					GroupId: String
				}
			]
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MemberReply: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			ClientId: 0,
			ErrorCode: 0,
			ErrorMessage: String,
			BillhighwayuserId: 0,
			UserId: String,
			GroupId: String
		}
	],
	IsError: False
}