Billhighway Cloud API

<back to all web services

GetCampaign

The following routes are available for this service:
GET/v1.1/campaigns/get/{campaignId*}
GET/v1.2/campaigns/get/{campaignId*}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetCampaign extends GetCampaign implements IReturnLegacyException
    {
        
    }

    public static class CampaignItem
    {
        public Integer Id = null;
        public String Name = null;
        public String SubTitle = null;
        public String Description = null;
        public Boolean HasGoal = null;
        public String DetailUri = null;
        public CampaignTheme Theme = null;
        public CampaignGoal Goal = null;
        public ArrayList<CampaignLevel> Levels = null;
        public String LogoUrl = null;
        public String HighResolutionLogoUrl = null;
        public Signup Signup = null;
        
        public Integer getId() { return Id; }
        public CampaignItem setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public CampaignItem setName(String value) { this.Name = value; return this; }
        public String getSubTitle() { return SubTitle; }
        public CampaignItem setSubTitle(String value) { this.SubTitle = value; return this; }
        public String getDescription() { return Description; }
        public CampaignItem setDescription(String value) { this.Description = value; return this; }
        public Boolean isHasGoal() { return HasGoal; }
        public CampaignItem setHasGoal(Boolean value) { this.HasGoal = value; return this; }
        public String getDetailUri() { return DetailUri; }
        public CampaignItem setDetailUri(String value) { this.DetailUri = value; return this; }
        public CampaignTheme getTheme() { return Theme; }
        public CampaignItem setTheme(CampaignTheme value) { this.Theme = value; return this; }
        public CampaignGoal getGoal() { return Goal; }
        public CampaignItem setGoal(CampaignGoal value) { this.Goal = value; return this; }
        public ArrayList<CampaignLevel> getLevels() { return Levels; }
        public CampaignItem setLevels(ArrayList<CampaignLevel> value) { this.Levels = value; return this; }
        public String getLogoUrl() { return LogoUrl; }
        public CampaignItem setLogoUrl(String value) { this.LogoUrl = value; return this; }
        public String getHighResolutionLogoUrl() { return HighResolutionLogoUrl; }
        public CampaignItem setHighResolutionLogoUrl(String value) { this.HighResolutionLogoUrl = value; return this; }
        public Signup getSignup() { return Signup; }
        public CampaignItem setSignup(Signup value) { this.Signup = value; return this; }
    }

    public static class CampaignTheme
    {
        public Integer Id = null;
        public String Name = null;
        public String MainColor = null;
        public String SecondaryColor = null;
        public CampaignThemeImage iPhone = null;
        public CampaignThemeImage iPhoneRetina = null;
        
        public Integer getId() { return Id; }
        public CampaignTheme setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public CampaignTheme setName(String value) { this.Name = value; return this; }
        public String getMainColor() { return MainColor; }
        public CampaignTheme setMainColor(String value) { this.MainColor = value; return this; }
        public String getSecondaryColor() { return SecondaryColor; }
        public CampaignTheme setSecondaryColor(String value) { this.SecondaryColor = value; return this; }
        public CampaignThemeImage getIPhone() { return iPhone; }
        public CampaignTheme setIPhone(CampaignThemeImage value) { this.iPhone = value; return this; }
        public CampaignThemeImage getIPhoneRetina() { return iPhoneRetina; }
        public CampaignTheme setIPhoneRetina(CampaignThemeImage value) { this.iPhoneRetina = value; return this; }
    }

    public static class CampaignThemeImage
    {
        public String BackgroundImage = null;
        public String Icon = null;
        
        public String getBackgroundImage() { return BackgroundImage; }
        public CampaignThemeImage setBackgroundImage(String value) { this.BackgroundImage = value; return this; }
        public String getIcon() { return Icon; }
        public CampaignThemeImage setIcon(String value) { this.Icon = value; return this; }
    }

    public static class CampaignGoal
    {
        public BigDecimal Target = null;
        public BigDecimal Actual = null;
        
        public BigDecimal getTarget() { return Target; }
        public CampaignGoal setTarget(BigDecimal value) { this.Target = value; return this; }
        public BigDecimal getActual() { return Actual; }
        public CampaignGoal setActual(BigDecimal value) { this.Actual = value; return this; }
    }

    public static class CampaignLevel
    {
        public Integer Sequence = null;
        public BigDecimal Amount = null;
        public String Description = null;
        
        public Integer getSequence() { return Sequence; }
        public CampaignLevel setSequence(Integer value) { this.Sequence = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public CampaignLevel setAmount(BigDecimal value) { this.Amount = value; return this; }
        public String getDescription() { return Description; }
        public CampaignLevel setDescription(String value) { this.Description = value; return this; }
    }

    public static class Signup
    {
        public Boolean ShowOnNewMembership = null;
        public Boolean ShowOnSignupRenewal = null;
        public Boolean ShowOtherAmount = null;
        
        public Boolean isShowOnNewMembership() { return ShowOnNewMembership; }
        public Signup setShowOnNewMembership(Boolean value) { this.ShowOnNewMembership = value; return this; }
        public Boolean isShowOnSignupRenewal() { return ShowOnSignupRenewal; }
        public Signup setShowOnSignupRenewal(Boolean value) { this.ShowOnSignupRenewal = value; return this; }
        public Boolean isShowOtherAmount() { return ShowOtherAmount; }
        public Signup setShowOtherAmount(Boolean value) { this.ShowOtherAmount = value; return this; }
    }

}

Java GetCampaign DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"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}}