| GET | /campaigns |
|---|
namespace BH.CloudAPI.Common.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type CampaignThemeImage() =
member val BackgroundImage:String = null with get,set
member val Icon:String = null with get,set
[<AllowNullLiteral>]
type CampaignTheme() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val MainColor:String = null with get,set
member val SecondaryColor:String = null with get,set
member val iPhone:CampaignThemeImage = null with get,set
member val iPhoneRetina:CampaignThemeImage = null with get,set
[<AllowNullLiteral>]
type CampaignGoal() =
member val Target:Decimal = new Decimal() with get,set
member val Actual:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type Signup() =
member val ShowOnNewMembership:Boolean = new Boolean() with get,set
member val ShowOnSignupRenewal:Boolean = new Boolean() with get,set
member val ShowOtherAmount:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type CampaignItem() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val SubTitle:String = null with get,set
member val Description:String = null with get,set
member val HasGoal:Boolean = new Boolean() with get,set
member val DetailUri:String = null with get,set
member val Theme:CampaignTheme = null with get,set
member val Goal:CampaignGoal = null with get,set
member val Levels:CampaignLevel[] = [||] with get,set
member val LogoUrl:String = null with get,set
member val HighResolutionLogoUrl:String = null with get,set
member val Signup:Signup = null with get,set
[<AllowNullLiteral>]
type CampaignRq() =
member val groupId:String = null with get,set
member val signUp:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val payment:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<AllowNullLiteral>]
type CampaignLevel() =
member val Sequence:Int32 = new Int32() with get,set
member val Amount:Decimal = new Decimal() with get,set
member val Description:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /campaigns 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>