Billhighway Cloud API

FormBuilderCampaignListRq

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

**FormBuilderCampaignListRq** Parameters:
Name	Parameter	Data Type	Required	Description
NatId	path	int	No
GroupId	path	int	No

**FormBuilderCampaignListRs** Parameters:
Name	Parameter	Data Type	Required	Description
campaignLists	form	List<CampaignItem>	No

**CampaignItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
SubTitle	form	string	No
Description	form	string	No
HasGoal	form	bool	No
DetailUri	form	string	No
Theme	form	CampaignTheme	No
Goal	form	CampaignGoal	No
Levels	form	CampaignLevel[]	No
LogoUrl	form	string	No
HighResolutionLogoUrl	form	string	No
Signup	form	Signup	No

**CampaignTheme** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
MainColor	form	string	No
SecondaryColor	form	string	No
iPhone	form	CampaignThemeImage	No
iPhoneRetina	form	CampaignThemeImage	No

**CampaignThemeImage** Parameters:
Name	Parameter	Data Type	Required	Description
BackgroundImage	form	string	No
Icon	form	string	No

**CampaignGoal** Parameters:
Name	Parameter	Data Type	Required	Description
Target	form	decimal	No
Actual	form	decimal	No

**CampaignLevel** Parameters:
Name	Parameter	Data Type	Required
Sequence	form	int	No
Amount	form	decimal	No
Description	form	string	No

**Signup** Parameters:
Name	Parameter	Data Type	Required
ShowOnNewMembership	form	bool	No
ShowOnSignupRenewal	form	bool	No
ShowOtherAmount	form	bool	No

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>