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

namespace BH.API.CloudApi.Core

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GroupSubscriptionInfoGetRq() = 
        member val GroupId:Int32 = new Int32() with get,set
        member val UserId:String = null with get,set
        member val UserType:String = null with get,set
        member val NatID:Int32 = new Int32() with get,set
        member val isPrintView:String = null with get,set

    [<AllowNullLiteral>]
    type ApiParameter() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type CountryInfo() = 
        member val CountryID:Int32 = new Int32() with get,set
        member val Abbr:String = null with get,set
        member val FullName:String = null with get,set
        member val IsoA2:String = null with get,set
        member val IsoNum:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type StateInfo() = 
        member val CountryID:Int32 = new Int32() with get,set
        member val StateID:Int32 = new Int32() with get,set
        member val Abbr:String = null with get,set
        member val FullName:String = null with get,set

    [<AllowNullLiteral>]
    type GroupBrandingInfo() = 
        member val Items:ResizeArray<ApiParameter> = new ResizeArray<ApiParameter>() with get,set
        member val Countries:IEnumerable<CountryInfo> = null with get,set
        member val States:IEnumerable<StateInfo> = null with get,set

    [<AllowNullLiteral>]
    type SubscriptionFrequency() = 
        member val ID:Int32 = new Int32() with get,set
        member val Description:String = null with get,set
        member val FriendlyDescription:String = null with get,set
        member val TotalAmount:Decimal = new Decimal() with get,set
        member val InstallmentAmount:Decimal = new Decimal() with get,set
        member val NumInstallments:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type GroupSubscriptionInvoiceItem() = 
        member val ID:Int64 = new Int64() with get,set
        member val Description:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Frequencies:ResizeArray<SubscriptionFrequency> = new ResizeArray<SubscriptionFrequency>() with get,set

    [<AllowNullLiteral>]
    type GroupSubscriptionInvoice() = 
        member val ID:Int64 = new Int64() with get,set
        member val LineageID:Int64 = new Int64() with get,set
        member val TypeID:Int32 = new Int32() with get,set
        member val Description:String = null with get,set
        member val InvoiceItems:ResizeArray<GroupSubscriptionInvoiceItem> = new ResizeArray<GroupSubscriptionInvoiceItem>() with get,set
        member val FrequencyTotals:ResizeArray<SubscriptionFrequency> = new ResizeArray<SubscriptionFrequency>() with get,set
        member val ClientSubscriptionTypeID:String = null with get,set

    [<AllowNullLiteral>]
    type GroupSubscriptionInvoiceType() = 
        member val ID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val SubscriptionInvoices:ResizeArray<GroupSubscriptionInvoice> = new ResizeArray<GroupSubscriptionInvoice>() with get,set
        member val SubscriptionInvTemplateTypeID:Int32 = new Int32() with get,set
        member val TemplateTypeName:String = null with get,set

    [<AllowNullLiteral>]
    type SubscriberFormField() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type SubscriberForm() = 
        member val ID:Int64 = new Int64() with get,set
        member val FormTempateID:Int32 = new Int32() with get,set
        member val SubscriptionInvoiceID:Int64 = new Int64() with get,set
        member val SignupTypeID:Int32 = new Int32() with get,set
        member val Fields:ResizeArray<SubscriberFormField> = new ResizeArray<SubscriberFormField>() with get,set

    [<AllowNullLiteral>]
    type CampaignThemeImage() = 
        member val BackgroundImage:String = null with get,set
        member val Icon:String = null with get,set

    [<AllowNullLiteral>]
    type CampaignTheme() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val MainColor:String = null with get,set
        member val SecondaryColor:String = null with get,set
        member val iPhone:CampaignThemeImage = null with get,set
        member val iPhoneRetina:CampaignThemeImage = null with get,set

    [<AllowNullLiteral>]
    type CampaignGoal() = 
        member val Target:Decimal = new Decimal() with get,set
        member val Actual:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type Signup() = 
        member val ShowOnNewMembership:Boolean = new Boolean() with get,set
        member val ShowOnSignupRenewal:Boolean = new Boolean() with get,set
        member val ShowOtherAmount:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CampaignItem() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val SubTitle:String = null with get,set
        member val Description:String = null with get,set
        member val HasGoal:Boolean = new Boolean() with get,set
        member val DetailUri:String = null with get,set
        member val Theme:CampaignTheme = null with get,set
        member val Goal:CampaignGoal = null with get,set
        member val Levels:CampaignLevel[] = [||] with get,set
        member val LogoUrl:String = null with get,set
        member val HighResolutionLogoUrl:String = null with get,set
        member val Signup:Signup = null with get,set

    [<AllowNullLiteral>]
    type GroupSubscriptionInfo() = 
        member val BrandingInfo:GroupBrandingInfo = null with get,set
        member val Subscriptions:IEnumerable<GroupSubscriptionInvoiceType> = null with get,set
        member val FormInfo:SubscriberForm = null with get,set
        member val Campaigns:IEnumerable<CampaignItem> = null with get,set

    [<AllowNullLiteral>]
    type Link() = 
        member val Rel:String = null with get,set
        member val Url:String = null with get,set

    [<AllowNullLiteral>]
    type GroupSubscriptionInfoGetRs() = 
        member val SignupInfo:GroupSubscriptionInfo = null with get,set
        member val Links:ResizeArray<Link> = new ResizeArray<Link>() with get,set

    [<AllowNullLiteral>]
    type CampaignLevel() = 
        member val Sequence:Int32 = new Int32() with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Description:String = null with get,set

F# 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>