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

export class GroupSubscriptionInfoGetRq implements IApiRequest
{
    public GroupId?: number;
    public UserId?: string;
    public UserType?: string;
    public NatID?: number;
    public isPrintView?: string;

    public constructor(init?: Partial<GroupSubscriptionInfoGetRq>) { (Object as any).assign(this, init); }
}

export class ApiParameter
{
    public Name?: string;
    public Value?: string;

    public constructor(init?: Partial<ApiParameter>) { (Object as any).assign(this, init); }
}

export class CountryInfo
{
    public CountryID?: number;
    public Abbr?: string;
    public FullName?: string;
    public IsoA2?: string;
    public IsoNum?: number;

    public constructor(init?: Partial<CountryInfo>) { (Object as any).assign(this, init); }
}

export class StateInfo
{
    public CountryID?: number;
    public StateID?: number;
    public Abbr?: string;
    public FullName?: string;

    public constructor(init?: Partial<StateInfo>) { (Object as any).assign(this, init); }
}

export class GroupBrandingInfo
{
    public Items?: ApiParameter[];
    public Countries?: CountryInfo[];
    public States?: StateInfo[];

    public constructor(init?: Partial<GroupBrandingInfo>) { (Object as any).assign(this, init); }
}

export class SubscriptionFrequency
{
    public ID?: number;
    public Description?: string;
    public FriendlyDescription?: string;
    public TotalAmount?: number;
    public InstallmentAmount?: number;
    public NumInstallments?: number;

    public constructor(init?: Partial<SubscriptionFrequency>) { (Object as any).assign(this, init); }
}

export class GroupSubscriptionInvoiceItem
{
    public ID?: number;
    public Description?: string;
    public Amount?: number;
    public Frequencies?: SubscriptionFrequency[];

    public constructor(init?: Partial<GroupSubscriptionInvoiceItem>) { (Object as any).assign(this, init); }
}

export class GroupSubscriptionInvoice
{
    public ID?: number;
    public LineageID?: number;
    public TypeID?: number;
    public Description?: string;
    public InvoiceItems?: GroupSubscriptionInvoiceItem[];
    public FrequencyTotals?: SubscriptionFrequency[];
    public ClientSubscriptionTypeID?: string;

    public constructor(init?: Partial<GroupSubscriptionInvoice>) { (Object as any).assign(this, init); }
}

export class GroupSubscriptionInvoiceType
{
    public ID?: number;
    public Name?: string;
    public SubscriptionInvoices?: GroupSubscriptionInvoice[];
    public SubscriptionInvTemplateTypeID?: number;
    public TemplateTypeName?: string;

    public constructor(init?: Partial<GroupSubscriptionInvoiceType>) { (Object as any).assign(this, init); }
}

export class SubscriberFormField
{
    public Name?: string;
    public Value?: string;

    public constructor(init?: Partial<SubscriberFormField>) { (Object as any).assign(this, init); }
}

export class SubscriberForm
{
    public ID?: number;
    public FormTempateID?: number;
    public SubscriptionInvoiceID?: number;
    public SignupTypeID?: number;
    public Fields?: SubscriberFormField[];

    public constructor(init?: Partial<SubscriberForm>) { (Object as any).assign(this, init); }
}

export class CampaignThemeImage
{
    public BackgroundImage?: string;
    public Icon?: string;

    public constructor(init?: Partial<CampaignThemeImage>) { (Object as any).assign(this, init); }
}

export class CampaignTheme
{
    public Id?: number;
    public Name?: string;
    public MainColor?: string;
    public SecondaryColor?: string;
    public iPhone?: CampaignThemeImage;
    public iPhoneRetina?: CampaignThemeImage;

    public constructor(init?: Partial<CampaignTheme>) { (Object as any).assign(this, init); }
}

export class CampaignGoal
{
    public Target?: number;
    public Actual?: number;

    public constructor(init?: Partial<CampaignGoal>) { (Object as any).assign(this, init); }
}

export class Signup
{
    public ShowOnNewMembership?: boolean;
    public ShowOnSignupRenewal?: boolean;
    public ShowOtherAmount?: boolean;

    public constructor(init?: Partial<Signup>) { (Object as any).assign(this, init); }
}

export class CampaignItem
{
    public Id?: number;
    public Name?: string;
    public SubTitle?: string;
    public Description?: string;
    public HasGoal?: boolean;
    public DetailUri?: string;
    public Theme?: CampaignTheme;
    public Goal?: CampaignGoal;
    public Levels?: CampaignLevel[];
    public LogoUrl?: string;
    public HighResolutionLogoUrl?: string;
    public Signup?: Signup;

    public constructor(init?: Partial<CampaignItem>) { (Object as any).assign(this, init); }
}

export class GroupSubscriptionInfo
{
    public BrandingInfo?: GroupBrandingInfo;
    public Subscriptions?: GroupSubscriptionInvoiceType[];
    public FormInfo?: SubscriberForm;
    public Campaigns?: CampaignItem[];

    public constructor(init?: Partial<GroupSubscriptionInfo>) { (Object as any).assign(this, init); }
}

export class Link
{
    public Rel?: string;
    public Url?: string;

    public constructor(init?: Partial<Link>) { (Object as any).assign(this, init); }
}

export class GroupSubscriptionInfoGetRs implements IApiResponse
{
    public SignupInfo?: GroupSubscriptionInfo;
    public Links?: Link[];

    public constructor(init?: Partial<GroupSubscriptionInfoGetRs>) { (Object as any).assign(this, init); }
}

export class CampaignLevel
{
    public Sequence?: number;
    public Amount?: number;
    public Description?: string;

    public constructor(init?: Partial<CampaignLevel>) { (Object as any).assign(this, init); }
}

TypeScript 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>