Billhighway Cloud API

<back to all web services

GetCampaign

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO;
using BH.CloudAPI.Common.Models;

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
{
    public partial class GetCampaign
        : GetCampaign, IReturnLegacyException
    {
    }

}

C# GetCampaign DTOs

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

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

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