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

namespace BH.API.CloudApi.Core
{
    public partial class ApiParameter
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
    }

    public partial class Link
    {
        public virtual string Rel { get; set; }
        public virtual string Url { get; set; }
    }

}

namespace BH.Client
{
    public partial class CountryInfo
    {
        public virtual int CountryID { get; set; }
        public virtual string Abbr { get; set; }
        public virtual string FullName { get; set; }
        public virtual string IsoA2 { get; set; }
        public virtual int IsoNum { get; set; }
    }

    public partial class StateInfo
    {
        public virtual int CountryID { get; set; }
        public virtual int StateID { get; set; }
        public virtual string Abbr { get; set; }
        public virtual string FullName { get; set; }
    }

}

namespace BH.CloudAPI.Common.Models
{
    public partial class CampaignGoal
    {
        public virtual decimal Target { get; set; }
        public virtual decimal Actual { get; set; }
    }

    public partial class CampaignItem
    {
        public CampaignItem()
        {
            Levels = new CampaignLevel[]{};
        }

        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual string SubTitle { get; set; }
        public virtual string Description { get; set; }
        public virtual bool HasGoal { get; set; }
        public virtual string DetailUri { get; set; }
        public virtual CampaignTheme Theme { get; set; }
        public virtual CampaignGoal Goal { get; set; }
        public virtual CampaignLevel[] Levels { get; set; }
        public virtual string LogoUrl { get; set; }
        public virtual string HighResolutionLogoUrl { get; set; }
        public virtual Signup Signup { get; set; }
    }

    public partial class CampaignLevel
    {
        public virtual int Sequence { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string Description { get; set; }
    }

    public partial class CampaignTheme
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual string MainColor { get; set; }
        public virtual string SecondaryColor { get; set; }
        public virtual CampaignThemeImage iPhone { get; set; }
        public virtual CampaignThemeImage iPhoneRetina { get; set; }
    }

    public partial class CampaignThemeImage
    {
        public virtual string BackgroundImage { get; set; }
        public virtual string Icon { get; set; }
    }

    public partial class Signup
    {
        public virtual bool ShowOnNewMembership { get; set; }
        public virtual bool ShowOnSignupRenewal { get; set; }
        public virtual bool ShowOtherAmount { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.SalesForce
{
    public partial class SubscriberFormField
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Subscriptions
{
    public partial class GroupBrandingInfo
    {
        public GroupBrandingInfo()
        {
            Items = new List<ApiParameter>{};
        }

        public virtual List<ApiParameter> Items { get; set; }
        public virtual IEnumerable<CountryInfo> Countries { get; set; }
        public virtual IEnumerable<StateInfo> States { get; set; }
    }

    public partial class GroupSubscriptionInfo
    {
        public virtual GroupBrandingInfo BrandingInfo { get; set; }
        public virtual IEnumerable<GroupSubscriptionInvoiceType> Subscriptions { get; set; }
        public virtual SubscriberForm FormInfo { get; set; }
        public virtual IEnumerable<CampaignItem> Campaigns { get; set; }
    }

    public partial class GroupSubscriptionInvoice
    {
        public GroupSubscriptionInvoice()
        {
            InvoiceItems = new List<GroupSubscriptionInvoiceItem>{};
            FrequencyTotals = new List<SubscriptionFrequency>{};
        }

        public virtual long ID { get; set; }
        public virtual long LineageID { get; set; }
        public virtual int TypeID { get; set; }
        public virtual string Description { get; set; }
        public virtual List<GroupSubscriptionInvoiceItem> InvoiceItems { get; set; }
        public virtual List<SubscriptionFrequency> FrequencyTotals { get; set; }
        public virtual string ClientSubscriptionTypeID { get; set; }
    }

    public partial class GroupSubscriptionInvoiceItem
    {
        public GroupSubscriptionInvoiceItem()
        {
            Frequencies = new List<SubscriptionFrequency>{};
        }

        public virtual long ID { get; set; }
        public virtual string Description { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual List<SubscriptionFrequency> Frequencies { get; set; }
    }

    public partial class GroupSubscriptionInvoiceType
    {
        public GroupSubscriptionInvoiceType()
        {
            SubscriptionInvoices = new List<GroupSubscriptionInvoice>{};
        }

        public virtual int ID { get; set; }
        public virtual string Name { get; set; }
        public virtual List<GroupSubscriptionInvoice> SubscriptionInvoices { get; set; }
        public virtual int SubscriptionInvTemplateTypeID { get; set; }
        public virtual string TemplateTypeName { get; set; }
    }

    public partial class SubscriberForm
    {
        public SubscriberForm()
        {
            Fields = new List<SubscriberFormField>{};
        }

        public virtual long ID { get; set; }
        public virtual int FormTempateID { get; set; }
        public virtual long SubscriptionInvoiceID { get; set; }
        public virtual int SignupTypeID { get; set; }
        public virtual List<SubscriberFormField> Fields { get; set; }
    }

    public partial class SubscriptionFrequency
    {
        public virtual int ID { get; set; }
        public virtual string Description { get; set; }
        public virtual string FriendlyDescription { get; set; }
        public virtual decimal TotalAmount { get; set; }
        public virtual decimal InstallmentAmount { get; set; }
        public virtual int NumInstallments { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Subscriptions.Request
{
    public partial class GroupSubscriptionInfoGetRq
        : IApiRequest
    {
        public virtual int GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual string UserType { get; set; }
        public virtual int NatID { get; set; }
        public virtual string isPrintView { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.Subscriptions.Response
{
    public partial class GroupSubscriptionInfoGetRs
        : IApiResponse
    {
        public GroupSubscriptionInfoGetRs()
        {
            Links = new List<Link>{};
        }

        public virtual GroupSubscriptionInfo SignupInfo { get; set; }
        public virtual List<Link> Links { get; set; }
    }

}

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