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
import Foundation
import ServiceStack

public class CampaignList : Campaigns, IReturnLegacyException
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class Campaigns : Codable
{
    required public init(){}
}

Swift CampaignList DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
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}}]