Billhighway Cloud API

FormBuilderCampaignListRq

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


export class FormBuilderCampaignListRq
{
    public NatId?: number;
    public GroupId?: number;

    public constructor(init?: Partial<FormBuilderCampaignListRq>) { (Object as any).assign(this, init); }
}

export class CampaignThemeImage
{
    public BackgroundImage?: string;
    public Icon?: string;

    public constructor(init?: Partial<CampaignThemeImage>) { (Object as any).assign(this, init); }
}

export class CampaignTheme
{
    public Id?: number;
    public Name?: string;
    public MainColor?: string;
    public SecondaryColor?: string;
    public iPhone?: CampaignThemeImage;
    public iPhoneRetina?: CampaignThemeImage;

    public constructor(init?: Partial<CampaignTheme>) { (Object as any).assign(this, init); }
}

export class CampaignGoal
{
    public Target?: number;
    public Actual?: number;

    public constructor(init?: Partial<CampaignGoal>) { (Object as any).assign(this, init); }
}

export class Signup
{
    public ShowOnNewMembership?: boolean;
    public ShowOnSignupRenewal?: boolean;
    public ShowOtherAmount?: boolean;

    public constructor(init?: Partial<Signup>) { (Object as any).assign(this, init); }
}

export class CampaignItem
{
    public Id?: number;
    public Name?: string;
    public SubTitle?: string;
    public Description?: string;
    public HasGoal?: boolean;
    public DetailUri?: string;
    public Theme?: CampaignTheme;
    public Goal?: CampaignGoal;
    public Levels?: CampaignLevel[];
    public LogoUrl?: string;
    public HighResolutionLogoUrl?: string;
    public Signup?: Signup;

    public constructor(init?: Partial<CampaignItem>) { (Object as any).assign(this, init); }
}

export class FormBuilderCampaignListRs
{
    public campaignLists?: CampaignItem[];

    public constructor(init?: Partial<FormBuilderCampaignListRs>) { (Object as any).assign(this, init); }
}

export class CampaignLevel
{
    public Sequence?: number;
    public Amount?: number;
    public Description?: string;

    public constructor(init?: Partial<CampaignLevel>) { (Object as any).assign(this, init); }
}

TypeScript FormBuilderCampaignListRq DTOs

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

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	campaignLists: 
	[
		{
			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
			}
		}
	]
}