Billhighway Cloud API

CampaignRq

The following routes are available for this service:
GET	/campaigns

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


open class CampaignRq
{
    var groupId:String? = null
    var signUp:Boolean? = null
    var payment:Boolean? = null
}

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 CampaignRq 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 /campaigns HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

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

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