Billhighway Cloud API

<back to all web services

CampaignList

The following routes are available for this service:
GET/v1.1/campaigns/list
GET/v1.2/campaigns/list
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.DTO;

namespace BH.CloudAPI.Common.DTO
{
    public partial class Campaigns
    {
    }

}

namespace BH.CloudAPI.Common4.DTO
{
    public partial class CampaignList
        : Campaigns, IReturnLegacyException
    {
    }

}

C# CampaignList 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 /v1.1/campaigns/list HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

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

<ArrayOfCampaignItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.Models">
  <CampaignItem>
    <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>
</ArrayOfCampaignItem>