Billhighway Cloud API

<back to all web services

CampaignInfoGetRq

The following routes are available for this service:
GET/signup/api/campaign/{memberSubscriptionInvId}
CampaignInfoGetRq Parameters:
NameParameterData TypeRequiredDescription
MemberSubscriptionInvIdpathintNo
CampaignInfoGetRs Parameters:
NameParameterData TypeRequiredDescription
CampaignsformIEnumerable<CampaignInformation>No
CampaignInformation Parameters:
NameParameterData TypeRequiredDescription
CampaignIdformintNo
CampaignNameformstringNo
AmountformdecimalNo
ChapPayIDformstringNo

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 /signup/api/campaign/{memberSubscriptionInvId} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignInfoGetRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions.Response">
  <Campaigns xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions" i:nil="true" />
</CampaignInfoGetRs>