POST api/PurchaseNewMembership
Processes and bills a new membership. If SessionKey is empty a new account will be created.
Request Information
URI Parameters
None.
Body Parameters
NewMembershipRequestName | Description | Type | Additional information |
---|---|---|---|
SessionKey |
If not provided all account data is required |
string | |
UserName |
Required if no session key is passed in |
string | |
Password |
Required if no session key is passed in |
string | |
InterestList |
List of interest Id values, set bool value to true |
Dictionary of integer [key] and boolean [value] | |
AutoRenewal | boolean | ||
AddOnMemberships |
Collection of add-on memberships |
Collection of AddOnMembership | |
MembershipLevel |
Membership level value |
string |
Required |
MembershipAmount |
Amount of the membership donation |
decimal number |
Required |
AdditionalDonationFundId |
Tessitura fund for any additional donation |
integer | |
AdditionalDonationAmount |
Amount of the additional donation |
decimal number | |
string | |||
Phone | string | ||
AdditionalFirstName |
For optional second person |
string | |
AdditionalLastName |
For optional second person |
string | |
AdditionalEmail |
For optional second person |
string | |
FirstName | string | ||
LastName | string | ||
Address1 | string | ||
Address2 | string | ||
City | string | ||
StateId |
Two letter state value from CountriesStates method |
string | |
CountryId | integer | ||
PostalCode | string | ||
CreditCardNumber | string |
Required |
|
CreditCardType |
Tessitura credit card Id value |
integer |
Required |
CreditCardName |
Name on credit card |
string |
Required |
CreditCardCVV | string |
Required |
|
CreditCardExpirationMonth | integer |
Required Range: inclusive between 1 and 12 |
|
CreditCardExpirationYear | integer |
Required |
|
StoredCreditCardId | integer | ||
SourceId |
For optional source id that will be used for the membership purchase session |
integer |
Request Formats
application/json, text/json
{ "SessionKey": "sample string 1", "UserName": "sample string 2", "Password": "sample string 3", "InterestList": { "1": true, "3": true }, "AutoRenewal": true, "AddOnMemberships": [ { "MembershipLevel": "sample string 1", "MembershipAmount": 2.0 }, { "MembershipLevel": "sample string 1", "MembershipAmount": 2.0 } ], "MembershipLevel": "sample string 5", "MembershipAmount": 6.0, "AdditionalDonationFundId": 7, "AdditionalDonationAmount": 8.0, "Email": "sample string 9", "Phone": "sample string 10", "AdditionalFirstName": "sample string 11", "AdditionalLastName": "sample string 12", "AdditionalEmail": "sample string 13", "FirstName": "sample string 14", "LastName": "sample string 15", "Address1": "sample string 16", "Address2": "sample string 17", "City": "sample string 18", "StateId": "sample string 19", "CountryId": 20, "PostalCode": "sample string 21", "CreditCardNumber": "sample string 22", "CreditCardType": 23, "CreditCardName": "sample string 24", "CreditCardCVV": "sample string 25", "CreditCardExpirationMonth": 26, "CreditCardExpirationYear": 27, "StoredCreditCardId": 28, "SourceId": 29 }
application/xml, text/xml
<NewMembershipRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Contribution"> <Address1>sample string 16</Address1> <Address2>sample string 17</Address2> <City>sample string 18</City> <CountryId>20</CountryId> <CreditCardCVV>sample string 25</CreditCardCVV> <CreditCardExpirationMonth>26</CreditCardExpirationMonth> <CreditCardExpirationYear>27</CreditCardExpirationYear> <CreditCardName>sample string 24</CreditCardName> <CreditCardNumber>sample string 22</CreditCardNumber> <CreditCardType>23</CreditCardType> <FirstName>sample string 14</FirstName> <LastName>sample string 15</LastName> <PostalCode>sample string 21</PostalCode> <SourceId>29</SourceId> <StateId>sample string 19</StateId> <StoredCreditCardId>28</StoredCreditCardId> <AdditionalDonationAmount>8</AdditionalDonationAmount> <AdditionalDonationFundId>7</AdditionalDonationFundId> <AdditionalEmail>sample string 13</AdditionalEmail> <AdditionalFirstName>sample string 11</AdditionalFirstName> <AdditionalLastName>sample string 12</AdditionalLastName> <Email>sample string 9</Email> <MembershipAmount>6</MembershipAmount> <MembershipLevel>sample string 5</MembershipLevel> <Phone>sample string 10</Phone> <AddOnMemberships> <AddOnMembership> <MembershipAmount>2</MembershipAmount> <MembershipLevel>sample string 1</MembershipLevel> </AddOnMembership> <AddOnMembership> <MembershipAmount>2</MembershipAmount> <MembershipLevel>sample string 1</MembershipLevel> </AddOnMembership> </AddOnMemberships> <AutoRenewal>true</AutoRenewal> <InterestList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfintboolean> <d2p1:Key>1</d2p1:Key> <d2p1:Value>true</d2p1:Value> </d2p1:KeyValueOfintboolean> <d2p1:KeyValueOfintboolean> <d2p1:Key>3</d2p1:Key> <d2p1:Value>true</d2p1:Value> </d2p1:KeyValueOfintboolean> </InterestList> <Password>sample string 3</Password> <SessionKey>sample string 1</SessionKey> <UserName>sample string 2</UserName> </NewMembershipRequest>
application/x-www-form-urlencoded
Response Information
Resource Description
NewMembershipResult object
ApiSuccessOfNewMembershipResultName | Description | Type | Additional information |
---|---|---|---|
Success | boolean | ||
Data | NewMembershipResult |
Response Formats
application/json
{ "Success": true, "Data": { "SessionKey": "RClHEee+NfmL7ITuTirEXp5cjHq1zYFFV+NopQe2nkq1VakjTtKss4uuDnMTKg/iE6np0dgQdSQKUdlEpjtSOqbmXzX82y9zGmqsRfyaJIU=", "AccountRegistered": true, "MembershipDonationAdded": true, "AdditionalDonationAdded": true, "AutoRenewalPaymentSaved": true, "AddOnMembershipsAdded": [ { "MembershipLevel": "sample string 1", "MembershipAmount": 2.0 }, { "MembershipLevel": "sample string 1", "MembershipAmount": 2.0 } ], "PurchaseCompleted": true, "OrderEmailSent": true, "OrderNumber": 8, "PrimaryAddressError": true, "NewSessionKey": "Wx5E4IWt7SKEEz+Tfyij5jHW0xXgjf2XCvr5UC/KFbLZZeXvvZDCrsSFq5zoGjAcQCQHt26mTgqWrVZPolua1HjoscIoOF9Rimi1pygTU7JOxQvUtbGXDBHtHsrwaodZ", "Error": [ "sample string 1", "sample string 2" ] } }
text/json
{ "Success": true, "Data": { "SessionKey": "ug2lBvtyNV5gl6uCDw19QzSI3d/wufnSyBxQ36QlIebWoS79JgkgyagcqUk/Gbaia9z4CEyE6DTb56yGryt5Lg/y2IqzvG789/y81UtdSG0=", "AccountRegistered": true, "MembershipDonationAdded": true, "AdditionalDonationAdded": true, "AutoRenewalPaymentSaved": true, "AddOnMembershipsAdded": [ { "MembershipLevel": "sample string 1", "MembershipAmount": 2.0 }, { "MembershipLevel": "sample string 1", "MembershipAmount": 2.0 } ], "PurchaseCompleted": true, "OrderEmailSent": true, "OrderNumber": 8, "PrimaryAddressError": true, "NewSessionKey": "N3LJtlsAZtVsFc2dKxFz2aD3qJ2ZiByU7iVzXVkKeCUKJGdrNMtYF9kQi0hpQ9OkQlmvQYy9X/NZHrzm4dCVXzBDnDxUWiDZe0NHc+OM/2H9p9tdsM4hZv3WwwG7J40G", "Error": [ "sample string 1", "sample string 2" ] } }
application/xml, text/xml
<ApiSuccessOfNewMembershipResultyx5QZ_PAX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Contribution"> <Error xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Error> <NewSessionKey xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">sample string 10</NewSessionKey> <OrderEmailSent xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</OrderEmailSent> <OrderNumber xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">8</OrderNumber> <PrimaryAddressError xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</PrimaryAddressError> <PurchaseCompleted xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Order">true</PurchaseCompleted> <d2p1:AccountRegistered>true</d2p1:AccountRegistered> <d2p1:AddOnMembershipsAdded> <d2p1:AddOnMembership> <d2p1:MembershipAmount>2</d2p1:MembershipAmount> <d2p1:MembershipLevel>sample string 1</d2p1:MembershipLevel> </d2p1:AddOnMembership> <d2p1:AddOnMembership> <d2p1:MembershipAmount>2</d2p1:MembershipAmount> <d2p1:MembershipLevel>sample string 1</d2p1:MembershipLevel> </d2p1:AddOnMembership> </d2p1:AddOnMembershipsAdded> <d2p1:AdditionalDonationAdded>true</d2p1:AdditionalDonationAdded> <d2p1:AutoRenewalPaymentSaved>true</d2p1:AutoRenewalPaymentSaved> <d2p1:MembershipDonationAdded>true</d2p1:MembershipDonationAdded> <d2p1:SessionKey>sample string 1</d2p1:SessionKey> </Data> </ApiSuccessOfNewMembershipResultyx5QZ_PAX>