POST api/PurchaseNewMembership

Request Information

URI Parameters

None.

Body Parameters

NewMembershipRequest
NameDescriptionTypeAdditional information
SessionKey

string
UserName

string
Password

string
InterestList

Dictionary of integer [key] and boolean [value]
AutoRenewal

boolean
AddOnMemberships

Collection of AddOnMembership
MembershipLevel

string

Required
MembershipAmount

decimal number

Required
AdditionalDonationFundId

integer
AdditionalDonationAmount

decimal number
Email

string
Phone

string
AdditionalFirstName

string
AdditionalLastName

string
AdditionalEmail

string
FirstName

string
LastName

string
Address1

string
Address2

string
City

string
StateId

string
CountryId

integer
PostalCode

string
CreditCardNumber

string

Required
CreditCardType

integer

Required
CreditCardName

string

Required
CreditCardCVV

string

Required
CreditCardExpirationMonth

integer

Required

Range: inclusive between 1 and 12
CreditCardExpirationYear

integer

Required
StoredCreditCardId

integer
SourceId

integer

Request Formats

application/json, text/json

Sample: 
{
  "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

Sample: 
<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

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'NewMembershipRequest'.

Response Information

Resource Description

ApiSuccessOfNewMembershipResult
NameDescriptionTypeAdditional information
Success

boolean
Data

NewMembershipResult

Response Formats

application/json

Sample: 
{
  "Success": true,
  "Data": {
    "SessionKey": "DW839uVSckFOKdeOasaHPO/V+HIQ9LQVxeiKwQrC93dG1ZomdeHdWKw4Ze5lKtvjqo/4GdzOjcqCOWo/twPG+kt8qwHrZ7z2crcaTmGBONg=",
    "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": "dc2tPgvUH/4W7JJ3QjAUFBWmQdJSbx18AH90ETwHOStjx51QNWBuBPZrVt2UfpLaQ1edyoUgL2jGt4CniPDWPpuUR9MqevKKQll+/tT4+Ipko7+AHIDsc/x7P86yV5Hl",
    "Error": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

text/json

Sample: 
{
  "Success": true,
  "Data": {
    "SessionKey": "FMuxh1miV+7DGJBI7oE3tV+9Y4UtuU98GJTBS3LzIehFC0XE09tG8P7HNRu2cFlAZssxD9tsBYNyvRqzyo+cdlKFqFO3jm+hQrKVj5ks/CY=",
    "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": "HNBex47l1zuLrb4C1G1sePfQwIHFWAHyOj9Byv3Eor+Dw6u10mXnAOatCQH3dK6kRkqYW1get/nIdJZE9bPjmpgeRSNwfInxsWBtnX2q9anjCubhXlmtvmVbGRNJXruf",
    "Error": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample: 
<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>