| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<Smp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
<AchPaymentInfo>
<AccountNumber>String</AccountNumber>
<AccountType>String</AccountType>
<AchReference>String</AchReference>
<Amount>0</Amount>
<AutoPay>false</AutoPay>
<BhUserId>0</BhUserId>
<CheckNumber>String</CheckNumber>
<ClassName>String</ClassName>
<ClientId>0</ClientId>
<Country>String</Country>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<CurrencyType>String</CurrencyType>
<EncryptionTypeId>0</EncryptionTypeId>
<GroupId>String</GroupId>
<InvoiceList>
<SalesForceMemberPaymentInvoiceDetail>
<AmountPaid>String</AmountPaid>
<ClassName>String</ClassName>
<ClientId>0</ClientId>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<Invoice>0</Invoice>
<UniqueId>String</UniqueId>
</SalesForceMemberPaymentInvoiceDetail>
</InvoiceList>
<Memo>String</Memo>
<PayerName>String</PayerName>
<PreferredEmailAddress>String</PreferredEmailAddress>
<RoutingNumber>String</RoutingNumber>
<StoreAchInfo>false</StoreAchInfo>
<UniqueId>String</UniqueId>
<UserId>String</UserId>
</AchPaymentInfo>
<AdminId>0</AdminId>
<BillMeLaterInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.Subscriptions">
<d2p1:Campaigns>
<d2p1:CampaignInformation>
<d2p1:Amount>0</d2p1:Amount>
<d2p1:CampaignId>0</d2p1:CampaignId>
<d2p1:CampaignName>String</d2p1:CampaignName>
<d2p1:ChapPayID>String</d2p1:ChapPayID>
</d2p1:CampaignInformation>
</d2p1:Campaigns>
<d2p1:IsBillMeLaterPayment>false</d2p1:IsBillMeLaterPayment>
<d2p1:IsBillMeLaterSubscription>false</d2p1:IsBillMeLaterSubscription>
<d2p1:MemberSubscriptionInvId>0</d2p1:MemberSubscriptionInvId>
</BillMeLaterInfo>
<CcPaymentInfo>
<Address1>String</Address1>
<Address2>String</Address2>
<Amount>String</Amount>
<AutoPay>false</AutoPay>
<BhUserId>0</BhUserId>
<BillingCity>String</BillingCity>
<BillingState>String</BillingState>
<CardReferenceOrCardNumber>String</CardReferenceOrCardNumber>
<CardType>String</CardType>
<ClassName>String</ClassName>
<ClientId>0</ClientId>
<Country>String</Country>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<CurrencyType>String</CurrencyType>
<Cvv>String</Cvv>
<ExpMonth>0</ExpMonth>
<ExpYear>0</ExpYear>
<GroupId>String</GroupId>
<InvoiceList>
<SalesForceMemberPaymentInvoiceDetail>
<AmountPaid>String</AmountPaid>
<ClassName>String</ClassName>
<ClientId>0</ClientId>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<Invoice>0</Invoice>
<UniqueId>String</UniqueId>
</SalesForceMemberPaymentInvoiceDetail>
</InvoiceList>
<Location>String</Location>
<Memo>String</Memo>
<NameOnCard>String</NameOnCard>
<OpportunityId>String</OpportunityId>
<PostalCode>String</PostalCode>
<PreferredEmailAddress>String</PreferredEmailAddress>
<StoreCardInfo>false</StoreCardInfo>
<UniqueId>String</UniqueId>
<UserId>String</UserId>
</CcPaymentInfo>
<ClientId>0</ClientId>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<GroupId>String</GroupId>
<MemberInfo>
<AccessLevel>String</AccessLevel>
<AlternateUserId>String</AlternateUserId>
<Attributes xmlns:d3p1="https://www.billhighway.com/api">
<d3p1:AttributeItem>
<d3p1:Name>String</d3p1:Name>
<d3p1:Value>String</d3p1:Value>
</d3p1:AttributeItem>
</Attributes>
<BhUserId>0</BhUserId>
<BillingType>String</BillingType>
<ClassName>String</ClassName>
<ClientId>0</ClientId>
<CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
<DOB>0001-01-01T00:00:00</DOB>
<DisableLogin>String</DisableLogin>
<DisplayName>String</DisplayName>
<FirstName>String</FirstName>
<FiscalYear>0</FiscalYear>
<FormFields>
<SubscriberFormField>
<_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>String</_x003C_Value_x003E_k__BackingField>
</SubscriberFormField>
</FormFields>
<GroupId>String</GroupId>
<GroupList xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
<d3p1:Chapter>
<d3p1:GroupId>String</d3p1:GroupId>
</d3p1:Chapter>
</GroupList>
<LastName>String</LastName>
<MemberStatus>String</MemberStatus>
<MemberTypeClient>String</MemberTypeClient>
<MiddleName>String</MiddleName>
<OtherEmailAddress>String</OtherEmailAddress>
<Paperless>String</Paperless>
<PreferredAddress1>String</PreferredAddress1>
<PreferredAddress2>String</PreferredAddress2>
<PreferredCity>String</PreferredCity>
<PreferredCountry>String</PreferredCountry>
<PreferredEmailAddress>String</PreferredEmailAddress>
<PreferredPhoneNumber>String</PreferredPhoneNumber>
<PreferredState>String</PreferredState>
<PreferredZip>String</PreferredZip>
<RecurringInvoiceSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.Member">
<d3p1:DonationAmount>String</d3p1:DonationAmount>
</RecurringInvoiceSettings>
<UniqueId>String</UniqueId>
<UserId>String</UserId>
<WorkLocation>String</WorkLocation>
</MemberInfo>
<Subscription>
<_x003C_AutoRenew_x003E_k__BackingField>false</_x003C_AutoRenew_x003E_k__BackingField>
<_x003C_ChapMemPayID_x003E_k__BackingField>0</_x003C_ChapMemPayID_x003E_k__BackingField>
<_x003C_ClientSubscriberId_x003E_k__BackingField>String</_x003C_ClientSubscriberId_x003E_k__BackingField>
<_x003C_CreatedBy_x003E_k__BackingField>0</_x003C_CreatedBy_x003E_k__BackingField>
<_x003C_Fields_x003E_k__BackingField>
<SubscriberFormField>
<_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
<_x003C_Value_x003E_k__BackingField>String</_x003C_Value_x003E_k__BackingField>
</SubscriberFormField>
</_x003C_Fields_x003E_k__BackingField>
<_x003C_FormTemplateID_x003E_k__BackingField>0</_x003C_FormTemplateID_x003E_k__BackingField>
<_x003C_FrequencyID_x003E_k__BackingField>0</_x003C_FrequencyID_x003E_k__BackingField>
<_x003C_RenewedMemberSubscriptionInvID_x003E_k__BackingField>0</_x003C_RenewedMemberSubscriptionInvID_x003E_k__BackingField>
<_x003C_SignupTypeID_x003E_k__BackingField>0</_x003C_SignupTypeID_x003E_k__BackingField>
<_x003C_SubscriptionInvoiceID_x003E_k__BackingField>0</_x003C_SubscriptionInvoiceID_x003E_k__BackingField>
<_x003C_SubscriptionTypeId_x003E_k__BackingField>String</_x003C_SubscriptionTypeId_x003E_k__BackingField>
<_x003C_UniqueId_x003E_k__BackingField>String</_x003C_UniqueId_x003E_k__BackingField>
<_x003C_UpdatedBy_x003E_k__BackingField>0</_x003C_UpdatedBy_x003E_k__BackingField>
<_x003C_UserID_x003E_k__BackingField>0</_x003C_UserID_x003E_k__BackingField>
</Subscription>
<UniqueId>String</UniqueId>
<UserId>0</UserId>
</Smp>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <SmpReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce"> <BillhighwayUserId>0</BillhighwayUserId> <ClientId>0</ClientId> <ConfirmationNumber>String</ConfirmationNumber> <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime> <ErrorCode>0</ErrorCode> <ErrorMessage>String</ErrorMessage> <PaymentConfirmationNumber>0</PaymentConfirmationNumber> <SubscriptionConfirmationNumber>0</SubscriptionConfirmationNumber> <UniqueId>String</UniqueId> </SmpReply>