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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.Subscriptions.Request
Imports BH.CloudAPI.Common4.DTO.Subscriptions.Response
Imports BH.CloudAPI.Common4.DTO.Subscriptions
Imports BH.API.CloudApi.Core
Imports BH.Client
Imports BH.CloudAPI.Common4.DTO.SalesForce
Imports BH.CloudAPI.Common.Models

Namespace Global

    Namespace BH.API.CloudApi.Core

        Public Partial Class ApiParameter
            Public Overridable Property Name As String
            Public Overridable Property Value As String
        End Class

        Public Partial Class Link
            Public Overridable Property Rel As String
            Public Overridable Property Url As String
        End Class
    End Namespace

    Namespace BH.Client

        Public Partial Class CountryInfo
            Public Overridable Property CountryID As Integer
            Public Overridable Property Abbr As String
            Public Overridable Property FullName As String
            Public Overridable Property IsoA2 As String
            Public Overridable Property IsoNum As Integer
        End Class

        Public Partial Class StateInfo
            Public Overridable Property CountryID As Integer
            Public Overridable Property StateID As Integer
            Public Overridable Property Abbr As String
            Public Overridable Property FullName As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common.Models

        Public Partial Class CampaignGoal
            Public Overridable Property Target As Decimal
            Public Overridable Property Actual As Decimal
        End Class

        Public Partial Class CampaignItem
            Public Sub New()
                Levels = New CampaignLevel(){}
            End Sub

            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property SubTitle As String
            Public Overridable Property Description As String
            Public Overridable Property HasGoal As Boolean
            Public Overridable Property DetailUri As String
            Public Overridable Property Theme As CampaignTheme
            Public Overridable Property Goal As CampaignGoal
            Public Overridable Property Levels As CampaignLevel()
            Public Overridable Property LogoUrl As String
            Public Overridable Property HighResolutionLogoUrl As String
            Public Overridable Property Signup As Signup
        End Class

        Public Partial Class CampaignLevel
            Public Overridable Property Sequence As Integer
            Public Overridable Property Amount As Decimal
            Public Overridable Property Description As String
        End Class

        Public Partial Class CampaignTheme
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property MainColor As String
            Public Overridable Property SecondaryColor As String
            Public Overridable Property iPhone As CampaignThemeImage
            Public Overridable Property iPhoneRetina As CampaignThemeImage
        End Class

        Public Partial Class CampaignThemeImage
            Public Overridable Property BackgroundImage As String
            Public Overridable Property Icon As String
        End Class

        Public Partial Class Signup
            Public Overridable Property ShowOnNewMembership As Boolean
            Public Overridable Property ShowOnSignupRenewal As Boolean
            Public Overridable Property ShowOtherAmount As Boolean
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.SalesForce

        Public Partial Class SubscriberFormField
            Public Overridable Property Name As String
            Public Overridable Property Value As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.Subscriptions

        Public Partial Class GroupBrandingInfo
            Public Sub New()
                Items = New List(Of ApiParameter)
            End Sub

            Public Overridable Property Items As List(Of ApiParameter)
            Public Overridable Property Countries As IEnumerable(Of CountryInfo)
            Public Overridable Property States As IEnumerable(Of StateInfo)
        End Class

        Public Partial Class GroupSubscriptionInfo
            Public Overridable Property BrandingInfo As GroupBrandingInfo
            Public Overridable Property Subscriptions As IEnumerable(Of GroupSubscriptionInvoiceType)
            Public Overridable Property FormInfo As SubscriberForm
            Public Overridable Property Campaigns As IEnumerable(Of CampaignItem)
        End Class

        Public Partial Class GroupSubscriptionInvoice
            Public Sub New()
                InvoiceItems = New List(Of GroupSubscriptionInvoiceItem)
                FrequencyTotals = New List(Of SubscriptionFrequency)
            End Sub

            Public Overridable Property ID As Long
            Public Overridable Property LineageID As Long
            Public Overridable Property TypeID As Integer
            Public Overridable Property Description As String
            Public Overridable Property InvoiceItems As List(Of GroupSubscriptionInvoiceItem)
            Public Overridable Property FrequencyTotals As List(Of SubscriptionFrequency)
            Public Overridable Property ClientSubscriptionTypeID As String
        End Class

        Public Partial Class GroupSubscriptionInvoiceItem
            Public Sub New()
                Frequencies = New List(Of SubscriptionFrequency)
            End Sub

            Public Overridable Property ID As Long
            Public Overridable Property Description As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property Frequencies As List(Of SubscriptionFrequency)
        End Class

        Public Partial Class GroupSubscriptionInvoiceType
            Public Sub New()
                SubscriptionInvoices = New List(Of GroupSubscriptionInvoice)
            End Sub

            Public Overridable Property ID As Integer
            Public Overridable Property Name As String
            Public Overridable Property SubscriptionInvoices As List(Of GroupSubscriptionInvoice)
            Public Overridable Property SubscriptionInvTemplateTypeID As Integer
            Public Overridable Property TemplateTypeName As String
        End Class

        Public Partial Class SubscriberForm
            Public Sub New()
                Fields = New List(Of SubscriberFormField)
            End Sub

            Public Overridable Property ID As Long
            Public Overridable Property FormTempateID As Integer
            Public Overridable Property SubscriptionInvoiceID As Long
            Public Overridable Property SignupTypeID As Integer
            Public Overridable Property Fields As List(Of SubscriberFormField)
        End Class

        Public Partial Class SubscriptionFrequency
            Public Overridable Property ID As Integer
            Public Overridable Property Description As String
            Public Overridable Property FriendlyDescription As String
            Public Overridable Property TotalAmount As Decimal
            Public Overridable Property InstallmentAmount As Decimal
            Public Overridable Property NumInstallments As Integer
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.Subscriptions.Request

        Public Partial Class GroupSubscriptionInfoGetRq
            Implements IApiRequest
            Public Overridable Property GroupId As Integer
            Public Overridable Property UserId As String
            Public Overridable Property UserType As String
            Public Overridable Property NatID As Integer
            Public Overridable Property isPrintView As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.Subscriptions.Response

        Public Partial Class GroupSubscriptionInfoGetRs
            Implements IApiResponse
            Public Sub New()
                Links = New List(Of Link)
            End Sub

            Public Overridable Property SignupInfo As GroupSubscriptionInfo
            Public Overridable Property Links As List(Of Link)
        End Class
    End Namespace
End Namespace

VB.NET GroupSubscriptionInfoGetRq DTOs

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>