Billhighway Cloud API

FormBuilderCampaignListRq

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class FormBuilderCampaignListRq
{
    var NatId:Int? = null
    var GroupId:Int? = null
}

open class FormBuilderCampaignListRs
{
    var campaignLists:ArrayList<CampaignItem> = ArrayList<CampaignItem>()
}

open class CampaignItem
{
    var Id:Int? = null
    var Name:String? = null
    var SubTitle:String? = null
    var Description:String? = null
    var HasGoal:Boolean? = null
    var DetailUri:String? = null
    var Theme:CampaignTheme? = null
    var Goal:CampaignGoal? = null
    var Levels:ArrayList<CampaignLevel>? = null
    var LogoUrl:String? = null
    var HighResolutionLogoUrl:String? = null
    var Signup:Signup? = null
}

open class CampaignTheme
{
    var Id:Int? = null
    var Name:String? = null
    var MainColor:String? = null
    var SecondaryColor:String? = null
    var iPhone:CampaignThemeImage? = null
    var iPhoneRetina:CampaignThemeImage? = null
}

open class CampaignThemeImage
{
    var BackgroundImage:String? = null
    var Icon:String? = null
}

open class CampaignGoal
{
    var Target:BigDecimal? = null
    var Actual:BigDecimal? = null
}

open class CampaignLevel
{
    var Sequence:Int? = null
    var Amount:BigDecimal? = null
    var Description:String? = null
}

open class Signup
{
    var ShowOnNewMembership:Boolean? = null
    var ShowOnSignupRenewal:Boolean? = null
    var ShowOtherAmount:Boolean? = null
}

Kotlin 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
			}
		}
	]
}