Billhighway Cloud API

FormBuilderCampaignListRq

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

import Foundation
import ServiceStack

public class FormBuilderCampaignListRq : Codable
{
    public var natId:Int?
    public var groupId:Int?

    required public init(){}
}

public class FormBuilderCampaignListRs : Codable
{
    public var campaignLists:[CampaignItem] = []

    required public init(){}
}

public class CampaignItem : Codable
{
    public var id:Int?
    public var name:String?
    public var subTitle:String?
    public var Description:String?
    public var hasGoal:Bool?
    public var detailUri:String?
    public var theme:CampaignTheme?
    public var goal:CampaignGoal?
    public var levels:[CampaignLevel] = []
    public var logoUrl:String?
    public var highResolutionLogoUrl:String?
    public var signup:Signup?

    required public init(){}
}

public class CampaignTheme : Codable
{
    public var id:Int?
    public var name:String?
    public var mainColor:String?
    public var secondaryColor:String?
    public var iPhone:CampaignThemeImage?
    public var iPhoneRetina:CampaignThemeImage?

    required public init(){}
}

public class CampaignThemeImage : Codable
{
    public var backgroundImage:String?
    public var icon:String?

    required public init(){}
}

public class CampaignGoal : Codable
{
    public var target:Double?
    public var actual:Double?

    required public init(){}
}

public class CampaignLevel : Codable
{
    public var sequence:Int?
    public var amount:Double?
    public var Description:String?

    required public init(){}
}

public class Signup : Codable
{
    public var showOnNewMembership:Bool?
    public var showOnSignupRenewal:Bool?
    public var showOtherAmount:Bool?

    required public init(){}
}

Swift 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>