Billhighway Cloud API

GetCampaign

The following routes are available for this service:
GET	/v1.1/campaigns/get/{campaignId*}
GET	/v1.2/campaigns/get/{campaignId*}

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 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 GetCampaign(GetCampaign, IReturnLegacyException):
    pass


@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 GetCampaign DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1.1/campaigns/get/{campaignId*} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Name: String,
	SubTitle: String,
	Description: String,
	HasGoal: False,
	DetailUri: /api/campaigns/get/0,
	Theme: 
	{
		Id: 0,
		Name: String,
		MainColor: String,
		SecondaryColor: String,
		iPhone: 
		{
			BackgroundImage: String,
			Icon: String
		},
		iPhoneRetina: 
		{
			BackgroundImage: String,
			Icon: String
		}
	},
	Goal: 
	{
		Target: 0,
		Actual: 0
	},
	Levels: 
	[
		{
			Sequence: 0,
			Amount: 0,
			Description: String
		}
	],
	LogoUrl: String,
	HighResolutionLogoUrl: String,
	Signup: 
	{
		ShowOnNewMembership: False,
		ShowOnSignupRenewal: False,
		ShowOtherAmount: False
	}
}