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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormBuilderCampaignListRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Response">
  <campaignLists xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.Models">
    <d2p1:CampaignItem>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Goal>
        <d2p1:Actual>0</d2p1:Actual>
        <d2p1:Target>0</d2p1:Target>
      </d2p1:Goal>
      <d2p1:HasGoal>false</d2p1:HasGoal>
      <d2p1:HighResolutionLogoUrl>String</d2p1:HighResolutionLogoUrl>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Levels>
        <d2p1:CampaignLevel>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:Sequence>0</d2p1:Sequence>
        </d2p1:CampaignLevel>
      </d2p1:Levels>
      <d2p1:LogoUrl>String</d2p1:LogoUrl>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Signup>
        <d2p1:ShowOnNewMembership>false</d2p1:ShowOnNewMembership>
        <d2p1:ShowOnSignupRenewal>false</d2p1:ShowOnSignupRenewal>
        <d2p1:ShowOtherAmount>false</d2p1:ShowOtherAmount>
      </d2p1:Signup>
      <d2p1:SubTitle>String</d2p1:SubTitle>
      <d2p1:Theme>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:MainColor>String</d2p1:MainColor>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:SecondaryColor>String</d2p1:SecondaryColor>
        <d2p1:iPhone>
          <d2p1:BackgroundImage>String</d2p1:BackgroundImage>
          <d2p1:Icon>String</d2p1:Icon>
        </d2p1:iPhone>
        <d2p1:iPhoneRetina>
          <d2p1:BackgroundImage>String</d2p1:BackgroundImage>
          <d2p1:Icon>String</d2p1:Icon>
        </d2p1:iPhoneRetina>
      </d2p1:Theme>
    </d2p1:CampaignItem>
  </campaignLists>
</FormBuilderCampaignListRs>