Billhighway Cloud API

<back to all web services

GroupSubscriptionInfoGetRq

The following routes are available for this service:
GET/signup/api/nat/{natID}/group/{groupId}/signup/info
GET/signup/api/nat/{natID}/group/{groupId}/{usertype}/user/{userid}/signup/info
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GroupSubscriptionInfoGetRq implements IApiRequest
    {
        public Integer GroupId = null;
        public String UserId = null;
        public String UserType = null;
        public Integer NatID = null;
        public String isPrintView = null;
        
        public Integer getGroupId() { return GroupId; }
        public GroupSubscriptionInfoGetRq setGroupId(Integer value) { this.GroupId = value; return this; }
        public String getUserId() { return UserId; }
        public GroupSubscriptionInfoGetRq setUserId(String value) { this.UserId = value; return this; }
        public String getUserType() { return UserType; }
        public GroupSubscriptionInfoGetRq setUserType(String value) { this.UserType = value; return this; }
        public Integer getNatID() { return NatID; }
        public GroupSubscriptionInfoGetRq setNatID(Integer value) { this.NatID = value; return this; }
        public String getIsPrintView() { return isPrintView; }
        public GroupSubscriptionInfoGetRq setIsPrintView(String value) { this.isPrintView = value; return this; }
    }

    public static class GroupSubscriptionInfoGetRs implements IApiResponse
    {
        public GroupSubscriptionInfo SignupInfo = null;
        public ArrayList<Link> Links = null;
        
        public GroupSubscriptionInfo getSignupInfo() { return SignupInfo; }
        public GroupSubscriptionInfoGetRs setSignupInfo(GroupSubscriptionInfo value) { this.SignupInfo = value; return this; }
        public ArrayList<Link> getLinks() { return Links; }
        public GroupSubscriptionInfoGetRs setLinks(ArrayList<Link> value) { this.Links = value; return this; }
    }

    public static class GroupSubscriptionInfo
    {
        public GroupBrandingInfo BrandingInfo = null;
        public ArrayList<GroupSubscriptionInvoiceType> Subscriptions = null;
        public SubscriberForm FormInfo = null;
        public ArrayList<CampaignItem> Campaigns = null;
        
        public GroupBrandingInfo getBrandingInfo() { return BrandingInfo; }
        public GroupSubscriptionInfo setBrandingInfo(GroupBrandingInfo value) { this.BrandingInfo = value; return this; }
        public ArrayList<GroupSubscriptionInvoiceType> getSubscriptions() { return Subscriptions; }
        public GroupSubscriptionInfo setSubscriptions(ArrayList<GroupSubscriptionInvoiceType> value) { this.Subscriptions = value; return this; }
        public SubscriberForm getFormInfo() { return FormInfo; }
        public GroupSubscriptionInfo setFormInfo(SubscriberForm value) { this.FormInfo = value; return this; }
        public ArrayList<CampaignItem> getCampaigns() { return Campaigns; }
        public GroupSubscriptionInfo setCampaigns(ArrayList<CampaignItem> value) { this.Campaigns = value; return this; }
    }

    public static class GroupBrandingInfo
    {
        public ArrayList<ApiParameter> Items = null;
        public ArrayList<CountryInfo> Countries = null;
        public ArrayList<StateInfo> States = null;
        
        public ArrayList<ApiParameter> getItems() { return Items; }
        public GroupBrandingInfo setItems(ArrayList<ApiParameter> value) { this.Items = value; return this; }
        public ArrayList<CountryInfo> getCountries() { return Countries; }
        public GroupBrandingInfo setCountries(ArrayList<CountryInfo> value) { this.Countries = value; return this; }
        public ArrayList<StateInfo> getStates() { return States; }
        public GroupBrandingInfo setStates(ArrayList<StateInfo> value) { this.States = value; return this; }
    }

    public static class ApiParameter
    {
        public String Name = null;
        public String Value = null;
        
        public String getName() { return Name; }
        public ApiParameter setName(String value) { this.Name = value; return this; }
        public String getValue() { return Value; }
        public ApiParameter setValue(String value) { this.Value = value; return this; }
    }

    public static class CountryInfo
    {
        public Integer CountryID = null;
        public String Abbr = null;
        public String FullName = null;
        public String IsoA2 = null;
        public Integer IsoNum = null;
        
        public Integer getCountryID() { return CountryID; }
        public CountryInfo setCountryID(Integer value) { this.CountryID = value; return this; }
        public String getAbbr() { return Abbr; }
        public CountryInfo setAbbr(String value) { this.Abbr = value; return this; }
        public String getFullName() { return FullName; }
        public CountryInfo setFullName(String value) { this.FullName = value; return this; }
        public String getIsoA2() { return IsoA2; }
        public CountryInfo setIsoA2(String value) { this.IsoA2 = value; return this; }
        public Integer getIsoNum() { return IsoNum; }
        public CountryInfo setIsoNum(Integer value) { this.IsoNum = value; return this; }
    }

    public static class StateInfo
    {
        public Integer CountryID = null;
        public Integer StateID = null;
        public String Abbr = null;
        public String FullName = null;
        
        public Integer getCountryID() { return CountryID; }
        public StateInfo setCountryID(Integer value) { this.CountryID = value; return this; }
        public Integer getStateID() { return StateID; }
        public StateInfo setStateID(Integer value) { this.StateID = value; return this; }
        public String getAbbr() { return Abbr; }
        public StateInfo setAbbr(String value) { this.Abbr = value; return this; }
        public String getFullName() { return FullName; }
        public StateInfo setFullName(String value) { this.FullName = value; return this; }
    }

    public static class GroupSubscriptionInvoiceType
    {
        public Integer ID = null;
        public String Name = null;
        public ArrayList<GroupSubscriptionInvoice> SubscriptionInvoices = null;
        public Integer SubscriptionInvTemplateTypeID = null;
        public String TemplateTypeName = null;
        
        public Integer getId() { return ID; }
        public GroupSubscriptionInvoiceType setId(Integer value) { this.ID = value; return this; }
        public String getName() { return Name; }
        public GroupSubscriptionInvoiceType setName(String value) { this.Name = value; return this; }
        public ArrayList<GroupSubscriptionInvoice> getSubscriptionInvoices() { return SubscriptionInvoices; }
        public GroupSubscriptionInvoiceType setSubscriptionInvoices(ArrayList<GroupSubscriptionInvoice> value) { this.SubscriptionInvoices = value; return this; }
        public Integer getSubscriptionInvTemplateTypeID() { return SubscriptionInvTemplateTypeID; }
        public GroupSubscriptionInvoiceType setSubscriptionInvTemplateTypeID(Integer value) { this.SubscriptionInvTemplateTypeID = value; return this; }
        public String getTemplateTypeName() { return TemplateTypeName; }
        public GroupSubscriptionInvoiceType setTemplateTypeName(String value) { this.TemplateTypeName = value; return this; }
    }

    public static class GroupSubscriptionInvoice
    {
        public Long ID = null;
        public Long LineageID = null;
        public Integer TypeID = null;
        public String Description = null;
        public ArrayList<GroupSubscriptionInvoiceItem> InvoiceItems = null;
        public ArrayList<SubscriptionFrequency> FrequencyTotals = null;
        public String ClientSubscriptionTypeID = null;
        
        public Long getId() { return ID; }
        public GroupSubscriptionInvoice setId(Long value) { this.ID = value; return this; }
        public Long getLineageID() { return LineageID; }
        public GroupSubscriptionInvoice setLineageID(Long value) { this.LineageID = value; return this; }
        public Integer getTypeID() { return TypeID; }
        public GroupSubscriptionInvoice setTypeID(Integer value) { this.TypeID = value; return this; }
        public String getDescription() { return Description; }
        public GroupSubscriptionInvoice setDescription(String value) { this.Description = value; return this; }
        public ArrayList<GroupSubscriptionInvoiceItem> getInvoiceItems() { return InvoiceItems; }
        public GroupSubscriptionInvoice setInvoiceItems(ArrayList<GroupSubscriptionInvoiceItem> value) { this.InvoiceItems = value; return this; }
        public ArrayList<SubscriptionFrequency> getFrequencyTotals() { return FrequencyTotals; }
        public GroupSubscriptionInvoice setFrequencyTotals(ArrayList<SubscriptionFrequency> value) { this.FrequencyTotals = value; return this; }
        public String getClientSubscriptionTypeID() { return ClientSubscriptionTypeID; }
        public GroupSubscriptionInvoice setClientSubscriptionTypeID(String value) { this.ClientSubscriptionTypeID = value; return this; }
    }

    public static class GroupSubscriptionInvoiceItem
    {
        public Long ID = null;
        public String Description = null;
        public BigDecimal Amount = null;
        public ArrayList<SubscriptionFrequency> Frequencies = null;
        
        public Long getId() { return ID; }
        public GroupSubscriptionInvoiceItem setId(Long value) { this.ID = value; return this; }
        public String getDescription() { return Description; }
        public GroupSubscriptionInvoiceItem setDescription(String value) { this.Description = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public GroupSubscriptionInvoiceItem setAmount(BigDecimal value) { this.Amount = value; return this; }
        public ArrayList<SubscriptionFrequency> getFrequencies() { return Frequencies; }
        public GroupSubscriptionInvoiceItem setFrequencies(ArrayList<SubscriptionFrequency> value) { this.Frequencies = value; return this; }
    }

    public static class SubscriptionFrequency
    {
        public Integer ID = null;
        public String Description = null;
        public String FriendlyDescription = null;
        public BigDecimal TotalAmount = null;
        public BigDecimal InstallmentAmount = null;
        public Integer NumInstallments = null;
        
        public Integer getId() { return ID; }
        public SubscriptionFrequency setId(Integer value) { this.ID = value; return this; }
        public String getDescription() { return Description; }
        public SubscriptionFrequency setDescription(String value) { this.Description = value; return this; }
        public String getFriendlyDescription() { return FriendlyDescription; }
        public SubscriptionFrequency setFriendlyDescription(String value) { this.FriendlyDescription = value; return this; }
        public BigDecimal getTotalAmount() { return TotalAmount; }
        public SubscriptionFrequency setTotalAmount(BigDecimal value) { this.TotalAmount = value; return this; }
        public BigDecimal getInstallmentAmount() { return InstallmentAmount; }
        public SubscriptionFrequency setInstallmentAmount(BigDecimal value) { this.InstallmentAmount = value; return this; }
        public Integer getNumInstallments() { return NumInstallments; }
        public SubscriptionFrequency setNumInstallments(Integer value) { this.NumInstallments = value; return this; }
    }

    public static class SubscriberForm
    {
        public Long ID = null;
        public Integer FormTempateID = null;
        public Long SubscriptionInvoiceID = null;
        public Integer SignupTypeID = null;
        public ArrayList<SubscriberFormField> Fields = null;
        
        public Long getId() { return ID; }
        public SubscriberForm setId(Long value) { this.ID = value; return this; }
        public Integer getFormTempateID() { return FormTempateID; }
        public SubscriberForm setFormTempateID(Integer value) { this.FormTempateID = value; return this; }
        public Long getSubscriptionInvoiceID() { return SubscriptionInvoiceID; }
        public SubscriberForm setSubscriptionInvoiceID(Long value) { this.SubscriptionInvoiceID = value; return this; }
        public Integer getSignupTypeID() { return SignupTypeID; }
        public SubscriberForm setSignupTypeID(Integer value) { this.SignupTypeID = value; return this; }
        public ArrayList<SubscriberFormField> getFields() { return Fields; }
        public SubscriberForm setFields(ArrayList<SubscriberFormField> value) { this.Fields = value; return this; }
    }

    public static class SubscriberFormField
    {
        public String Name = null;
        public String Value = null;
        
        public String getName() { return Name; }
        public SubscriberFormField setName(String value) { this.Name = value; return this; }
        public String getValue() { return Value; }
        public SubscriberFormField setValue(String value) { this.Value = value; return this; }
    }

    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; }
    }

    public static class Link
    {
        public String Rel = null;
        public String Url = null;
        
        public String getRel() { return Rel; }
        public Link setRel(String value) { this.Rel = value; return this; }
        public String getUrl() { return Url; }
        public Link setUrl(String value) { this.Url = value; return this; }
    }

}

Java GroupSubscriptionInfoGetRq 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 /signup/api/nat/{natID}/group/{groupId}/signup/info HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"SignupInfo":{"BrandingInfo":{"Items":[{"Name":"String","Value":"String"}]},"FormInfo":{"ID":0,"FormTempateID":0,"SubscriptionInvoiceID":0,"SignupTypeID":0,"Fields":[{"FormTemplateFieldID":0,"Name":"String","Value":"String"}]}},"Links":[{"Rel":"String","Url":"String"}]}