| POST | /SMP |
|---|
import Foundation
import ServiceStack
public class Smp : Codable
{
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var groupId:String?
public var userId:Int?
public var adminId:Int?
public var memberInfo:Member?
public var ccPaymentInfo:CreditCardPayment?
public var achPaymentInfo:AchPayment?
public var subscription:Subscription?
public var billMeLaterInfo:BillMeLaterInformation?
required public init(){}
}
public class Member : Codable
{
public var className:String?
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var groupId:String?
public var userId:String?
public var alternateUserId:String?
public var bhUserId:Int?
public var firstName:String?
public var lastName:String?
public var middleName:String?
public var preferredEmailAddress:String?
public var otherEmailAddress:String?
public var preferredPhoneNumber:String?
public var preferredAddress1:String?
public var preferredAddress2:String?
public var preferredCity:String?
public var preferredState:String?
public var preferredZip:String?
public var preferredCountry:String?
public var accessLevel:String?
public var memberStatus:String?
public var memberTypeClient:String?
public var billingType:String?
public var fiscalYear:Int?
public var workLocation:String?
public var dob:Date?
public var paperless:String?
public var displayName:String?
public var disableLogin:String?
public var recurringInvoiceSettings:RecurringInvoiceSettings?
public var formFields:[SubscriberFormField] = []
public var attributes:[AttributeItem] = []
public var groupList:[Chapter] = []
required public init(){}
}
public class RecurringInvoiceSettings : Codable
{
public var donationAmount:String?
required public init(){}
}
public class SubscriberFormField : Codable
{
public var name:String?
public var value:String?
required public init(){}
}
public class AttributeItem : Codable
{
public var name:String?
public var value:String?
required public init(){}
}
public class Chapter : Codable
{
public var groupId:String?
required public init(){}
}
public class CreditCardPayment : CreditCardPayment
{
public var subscriptionInfo:SubscriptionParameters?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case subscriptionInfo
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
subscriptionInfo = try container.decodeIfPresent(SubscriptionParameters.self, forKey: .subscriptionInfo)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if subscriptionInfo != nil { try container.encode(subscriptionInfo, forKey: .subscriptionInfo) }
}
}
public class SubscriptionParameters : Codable
{
public var formTemplateID:Int?
public var subscriptionInvoiceID:Int?
public var clientSubscriberId:String?
public var signupTypeID:Int?
public var frequencyID:Int?
public var autoRenew:Bool?
public var companyID:Int?
public var userID:Int?
public var chapMemPayID:Int?
public var memberSubscriptionInvID:Int?
public var fields:[SubscriberFormField] = []
public var createdBy:Int?
public var updatedBy:Int?
public var aptifyUpdateType:Int?
public var renewedMemberSubscriptionInvID:Int?
public var chapId:Int?
required public init(){}
}
public class AchPayment : Codable
{
public var className:String?
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var groupId:String?
public var userId:String?
public var bhUserId:Int?
public var amount:Double?
public var currencyType:String?
public var country:String?
public var routingNumber:String?
public var accountNumber:String?
public var achReference:String?
public var accountType:String?
public var isSavingsAccount:Bool?
public var payerName:String?
public var checkNumber:String?
public var preferredEmailAddress:String?
public var memo:String?
public var invoiceList:[SalesForceMemberPaymentInvoiceDetail] = []
public var autoPay:Bool?
public var storeAchInfo:Bool?
public var encryptionTypeId:Int?
required public init(){}
}
public class SalesForceMemberPaymentInvoiceDetail : Codable
{
public var className:String?
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var invoice:Int?
public var amountPaid:String?
required public init(){}
}
public class Subscription : Codable
{
public var uniqueId:String?
public var formTemplateID:Int?
public var subscriptionInvoiceID:Int?
public var clientSubscriberId:String?
public var signupTypeID:Int?
public var frequencyID:Int?
public var autoRenew:Bool?
public var userID:Int?
public var chapMemPayID:Int?
public var fields:[SubscriberFormField] = []
public var createdBy:Int?
public var updatedBy:Int?
public var renewedMemberSubscriptionInvID:Int?
public var subscriptionTypeId:String?
required public init(){}
}
public class BillMeLaterInformation : Codable
{
public var isBillMeLaterPayment:Bool?
public var isBillMeLaterSubscription:Bool?
public var memberSubscriptionInvId:Int?
public var campaigns:[CampaignInformation] = []
required public init(){}
}
public class CampaignInformation : Codable
{
public var campaignId:Int?
public var campaignName:String?
public var amount:Double?
public var chapPayID:String?
required public init(){}
}
public class SmpReply : IHaveErrorField, Codable
{
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var billhighwayUserId:Int?
public var confirmationNumber:String?
public var paymentConfirmationNumber:Int?
public var subscriptionConfirmationNumber:Int?
public var errorCode:Int?
public var errorMessage:String?
public var isError:Bool?
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /SMP HTTP/1.1
Host: devapi.billhighway.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":0,"AdminId":0,"MemberInfo":{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","AlternateUserId":"String","BhUserId":0,"FirstName":"String","LastName":"String","MiddleName":"String","PreferredEmailAddress":"String","OtherEmailAddress":"String","PreferredPhoneNumber":"String","PreferredAddress1":"String","PreferredAddress2":"String","PreferredCity":"String","PreferredState":"String","PreferredZip":"String","PreferredCountry":"String","AccessLevel":"String","MemberStatus":"String","MemberTypeClient":"String","BillingType":"String","FiscalYear":0,"WorkLocation":"String","DOB":"0001-01-01T00:00:00.0000000","Paperless":"String","DisplayName":"String","DisableLogin":"String","RecurringInvoiceSettings":{"DonationAmount":"String"},"FormFields":[{"Name":"String","Value":"String"}],"Attributes":[{"Name":"String","Value":"String"}],"GroupList":[{"GroupId":"String"}]},"CcPaymentInfo":{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"Amount":"String","AutoPay":false,"CurrencyType":"String","Country":"String","CardReferenceOrCardNumber":"String","StoreCardInfo":false,"Address1":"String","Address2":"String","BillingCity":"String","BillingState":"String","PreferredEmailAddress":"String","Memo":"String","OpportunityId":"String","ExpMonth":0,"ExpYear":0,"Cvv":"String","PostalCode":"String","Location":"String","NameOnCard":"String","CardType":"String","InvoiceList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"Invoice":0,"AmountPaid":"String"}]},"AchPaymentInfo":{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","BhUserId":0,"Amount":0,"CurrencyType":"String","Country":"String","RoutingNumber":"String","AccountNumber":"String","AchReference":"String","AccountType":"String","IsSavingsAccount":false,"PayerName":"String","CheckNumber":"String","PreferredEmailAddress":"String","Memo":"String","InvoiceList":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"Invoice":0,"AmountPaid":"String"}],"AutoPay":false,"StoreAchInfo":false,"EncryptionTypeId":0},"Subscription":{"UniqueId":"String","FormTemplateID":0,"SubscriptionInvoiceID":0,"ClientSubscriberId":"String","SignupTypeID":0,"FrequencyID":0,"AutoRenew":false,"UserID":0,"ChapMemPayID":0,"Fields":[{"Name":"String","Value":"String"}],"CreatedBy":0,"UpdatedBy":0,"RenewedMemberSubscriptionInvID":0,"SubscriptionTypeId":"String"},"BillMeLaterInfo":{"IsBillMeLaterPayment":false,"IsBillMeLaterSubscription":false,"MemberSubscriptionInvId":0,"Campaigns":[{"CampaignId":0,"CampaignName":"String","Amount":0,"ChapPayID":"String"}]}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"BillhighwayUserId":0,"ConfirmationNumber":"String","PaymentConfirmationNumber":0,"SubscriptionConfirmationNumber":0,"ErrorCode":0,"ErrorMessage":"String","IsError":false}