Billhighway Cloud API

FormBuilderCampaignListRq

The following routes are available for this service:
GET	/signup/api/nat/{natID}/group/{groupId}/campaignListInfo

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderCampaignListRq:
    nat_id: Optional[int] = None
    group_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignThemeImage:
    background_image: Optional[str] = None
    icon: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignTheme:
    id: Optional[int] = None
    name: Optional[str] = None
    main_color: Optional[str] = None
    secondary_color: Optional[str] = None
    i_phone: Optional[CampaignThemeImage] = None
    i_phone_retina: Optional[CampaignThemeImage] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignGoal:
    target: Optional[Decimal] = None
    actual: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Signup:
    show_on_new_membership: Optional[bool] = None
    show_on_signup_renewal: Optional[bool] = None
    show_other_amount: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignItem:
    id: Optional[int] = None
    name: Optional[str] = None
    sub_title: Optional[str] = None
    description: Optional[str] = None
    has_goal: Optional[bool] = None
    detail_uri: Optional[str] = None
    theme: Optional[CampaignTheme] = None
    goal: Optional[CampaignGoal] = None
    levels: Optional[List[CampaignLevel]] = None
    logo_url: Optional[str] = None
    high_resolution_logo_url: Optional[str] = None
    signup: Optional[Signup] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormBuilderCampaignListRs:
    campaign_lists: Optional[List[CampaignItem]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignLevel:
    sequence: Optional[int] = None
    amount: Optional[Decimal] = None
    description: Optional[str] = None

Python FormBuilderCampaignListRq 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}/campaignListInfo HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

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

<FormBuilderCampaignListRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.FormBuilder.Response">
  <campaignLists xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.Models">
    <d2p1:CampaignItem>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Goal>
        <d2p1:Actual>0</d2p1:Actual>
        <d2p1:Target>0</d2p1:Target>
      </d2p1:Goal>
      <d2p1:HasGoal>false</d2p1:HasGoal>
      <d2p1:HighResolutionLogoUrl>String</d2p1:HighResolutionLogoUrl>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Levels>
        <d2p1:CampaignLevel>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:Sequence>0</d2p1:Sequence>
        </d2p1:CampaignLevel>
      </d2p1:Levels>
      <d2p1:LogoUrl>String</d2p1:LogoUrl>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Signup>
        <d2p1:ShowOnNewMembership>false</d2p1:ShowOnNewMembership>
        <d2p1:ShowOnSignupRenewal>false</d2p1:ShowOnSignupRenewal>
        <d2p1:ShowOtherAmount>false</d2p1:ShowOtherAmount>
      </d2p1:Signup>
      <d2p1:SubTitle>String</d2p1:SubTitle>
      <d2p1:Theme>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:MainColor>String</d2p1:MainColor>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:SecondaryColor>String</d2p1:SecondaryColor>
        <d2p1:iPhone>
          <d2p1:BackgroundImage>String</d2p1:BackgroundImage>
          <d2p1:Icon>String</d2p1:Icon>
        </d2p1:iPhone>
        <d2p1:iPhoneRetina>
          <d2p1:BackgroundImage>String</d2p1:BackgroundImage>
          <d2p1:Icon>String</d2p1:Icon>
        </d2p1:iPhoneRetina>
      </d2p1:Theme>
    </d2p1:CampaignItem>
  </campaignLists>
</FormBuilderCampaignListRs>