Billhighway Cloud API

FormBuilderCampaignListRq

The following routes are available for this service:
GET	/signup/api/nat/{natID}/group/{groupId}/campaignListInfo

namespace BH.CloudAPI.Common.Models

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

    [<AllowNullLiteral>]
    type FormBuilderCampaignListRq() = 
        member val NatId:Int32 = new Int32() with get,set
        member val GroupId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CampaignThemeImage() = 
        member val BackgroundImage:String = null with get,set
        member val Icon:String = null with get,set

    [<AllowNullLiteral>]
    type CampaignTheme() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val MainColor:String = null with get,set
        member val SecondaryColor:String = null with get,set
        member val iPhone:CampaignThemeImage = null with get,set
        member val iPhoneRetina:CampaignThemeImage = null with get,set

    [<AllowNullLiteral>]
    type CampaignGoal() = 
        member val Target:Decimal = new Decimal() with get,set
        member val Actual:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type Signup() = 
        member val ShowOnNewMembership:Boolean = new Boolean() with get,set
        member val ShowOnSignupRenewal:Boolean = new Boolean() with get,set
        member val ShowOtherAmount:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CampaignItem() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val SubTitle:String = null with get,set
        member val Description:String = null with get,set
        member val HasGoal:Boolean = new Boolean() with get,set
        member val DetailUri:String = null with get,set
        member val Theme:CampaignTheme = null with get,set
        member val Goal:CampaignGoal = null with get,set
        member val Levels:CampaignLevel[] = [||] with get,set
        member val LogoUrl:String = null with get,set
        member val HighResolutionLogoUrl:String = null with get,set
        member val Signup:Signup = null with get,set

    [<AllowNullLiteral>]
    type FormBuilderCampaignListRs() = 
        member val campaignLists:ResizeArray<CampaignItem> = new ResizeArray<CampaignItem>() with get,set

    [<AllowNullLiteral>]
    type CampaignLevel() = 
        member val Sequence:Int32 = new Int32() with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Description:String = null with get,set

F# FormBuilderCampaignListRq 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.

GET /signup/api/nat/{natID}/group/{groupId}/campaignListInfo HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv

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

{
	campaignLists: 
	[
		{
			Id: 0,
			Name: String,
			SubTitle: String,
			Description: String,
			HasGoal: False,
			DetailUri: /api/campaigns/get/0,
			Theme: 
			{
				Id: 0,
				Name: String,
				MainColor: String,
				SecondaryColor: String,
				iPhone: 
				{
					BackgroundImage: String,
					Icon: String
				},
				iPhoneRetina: 
				{
					BackgroundImage: String,
					Icon: String
				}
			},
			Goal: 
			{
				Target: 0,
				Actual: 0
			},
			Levels: 
			[
				{
					Sequence: 0,
					Amount: 0,
					Description: String
				}
			],
			LogoUrl: String,
			HighResolutionLogoUrl: String,
			Signup: 
			{
				ShowOnNewMembership: False,
				ShowOnSignupRenewal: False,
				ShowOtherAmount: False
			}
		}
	]
}