Billhighway Cloud API

GetCampaign

The following routes are available for this service:
GET	/v1.1/campaigns/get/{campaignId*}
GET	/v1.2/campaigns/get/{campaignId*}

import Foundation
import ServiceStack

public class GetCampaign : GetCampaign, IReturnLegacyException
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

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 GetCampaign 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 /v1.1/campaigns/get/{campaignId*} 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>