Billhighway Cloud API

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

**GroupSubscriptionInfoGetRq** Parameters:
Name	Parameter	Data Type	Required
GroupId	path	int	No
UserId	path	string	No
UserType	path	string	No
NatID	path	int	No
isPrintView	query	string	No

**GroupSubscriptionInfoGetRs** Parameters:
Name	Parameter	Data Type	Required	Description
SignupInfo	form	GroupSubscriptionInfo	No
Links	form	List<Link>	No

**GroupSubscriptionInfo** Parameters:
Name	Parameter	Data Type	Required
BrandingInfo	form	GroupBrandingInfo	No
Subscriptions	form	IEnumerable<GroupSubscriptionInvoiceType>	No
FormInfo	form	SubscriberForm	No
Campaigns	form	IEnumerable<CampaignItem>	No

**GroupBrandingInfo** Parameters:
Name	Parameter	Data Type	Required
Items	form	List<ApiParameter>	No
Countries	form	IEnumerable<CountryInfo>	No
States	form	IEnumerable<StateInfo>	No

**ApiParameter** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**CountryInfo** Parameters:
Name	Parameter	Data Type	Required
CountryID	form	int	No
Abbr	form	string	No
FullName	form	string	No
IsoA2	form	string	No
IsoNum	form	int	No

**StateInfo** Parameters:
Name	Parameter	Data Type	Required
CountryID	form	int	No
StateID	form	int	No
Abbr	form	string	No
FullName	form	string	No

**GroupSubscriptionInvoiceType** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
Name	form	string	No
SubscriptionInvoices	form	List<GroupSubscriptionInvoice>	No
SubscriptionInvTemplateTypeID	form	int	No
TemplateTypeName	form	string	No

**GroupSubscriptionInvoice** Parameters:
Name	Parameter	Data Type	Required
ID	form	long	No
LineageID	form	long	No
TypeID	form	int	No
Description	form	string	No
InvoiceItems	form	List<GroupSubscriptionInvoiceItem>	No
FrequencyTotals	form	List<SubscriptionFrequency>	No
ClientSubscriptionTypeID	form	string	No

**GroupSubscriptionInvoiceItem** Parameters:
Name	Parameter	Data Type	Required
ID	form	long	No
Description	form	string	No
Amount	form	decimal	No
Frequencies	form	List<SubscriptionFrequency>	No

**SubscriptionFrequency** Parameters:
Name	Parameter	Data Type	Required
ID	form	int	No
Description	form	string	No
FriendlyDescription	form	string	No
TotalAmount	form	decimal	No
InstallmentAmount	form	decimal	No
NumInstallments	form	int	No

**SubscriberForm** Parameters:
Name	Parameter	Data Type	Required
ID	form	long	No
FormTempateID	form	int	No
SubscriptionInvoiceID	form	long	No
SignupTypeID	form	int	No
Fields	form	List<SubscriberFormField>	No

**SubscriberFormField** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	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

**Link** Parameters:
Name	Parameter	Data Type	Required	Description
Rel	form	string	No
Url	form	string	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}/signup/info HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GroupSubscriptionInfoGetRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions.Response">
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.API.CloudApi.Core">
    <d2p1:Link>
      <d2p1:Rel>String</d2p1:Rel>
      <d2p1:Url>String</d2p1:Url>
    </d2p1:Link>
  </Links>
  <SignupInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
    <d2p1:_x003C_BrandingInfo_x003E_k__BackingField>
      <d2p1:_x003C_Countries_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.Client" i:nil="true" />
      <d2p1:_x003C_Items_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.API.CloudApi.Core">
        <d4p1:ApiParameter>
          <d4p1:_x003C_Name_x003E_k__BackingField>String</d4p1:_x003C_Name_x003E_k__BackingField>
          <d4p1:_x003C_Value_x003E_k__BackingField>String</d4p1:_x003C_Value_x003E_k__BackingField>
        </d4p1:ApiParameter>
      </d2p1:_x003C_Items_x003E_k__BackingField>
      <d2p1:_x003C_States_x003E_k__BackingField xmlns:d4p1="http://schemas.datacontract.org/2004/07/BH.Client" i:nil="true" />
    </d2p1:_x003C_BrandingInfo_x003E_k__BackingField>
    <d2p1:_x003C_Campaigns_x003E_k__BackingField xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.Models" i:nil="true" />
    <d2p1:_x003C_FormInfo_x003E_k__BackingField>
      <d2p1:_x003C_Fields_x003E_k__BackingField>
        <d2p1:SubscriberFormField>
          <d2p1:_x003C_FormTemplateFieldID_x003E_k__BackingField>0</d2p1:_x003C_FormTemplateFieldID_x003E_k__BackingField>
          <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
          <d2p1:_x003C_Value_x003E_k__BackingField>String</d2p1:_x003C_Value_x003E_k__BackingField>
        </d2p1:SubscriberFormField>
      </d2p1:_x003C_Fields_x003E_k__BackingField>
      <d2p1:_x003C_FormTempateID_x003E_k__BackingField>0</d2p1:_x003C_FormTempateID_x003E_k__BackingField>
      <d2p1:_x003C_ID_x003E_k__BackingField>0</d2p1:_x003C_ID_x003E_k__BackingField>
      <d2p1:_x003C_SignupTypeID_x003E_k__BackingField>0</d2p1:_x003C_SignupTypeID_x003E_k__BackingField>
      <d2p1:_x003C_SubscriptionInvoiceID_x003E_k__BackingField>0</d2p1:_x003C_SubscriptionInvoiceID_x003E_k__BackingField>
    </d2p1:_x003C_FormInfo_x003E_k__BackingField>
    <d2p1:_x003C_Subscriptions_x003E_k__BackingField i:nil="true" />
  </SignupInfo>
</GroupSubscriptionInfoGetRs>