POST api/PurchaseGiftMembership
Request Information
URI Parameters
None.
Body Parameters
GiftMembershipRequestName | Description | Type | Additional information |
---|---|---|---|
SessionKey | string |
Required |
|
RecipientFirstName | string |
Required |
|
RecipientLastName | string |
Required |
|
RecipientAddress1 | string | ||
RecipientAddress2 | string | ||
RecipientCity | string | ||
RecipientStateId | string | ||
RecipientCountryId | integer | ||
RecipientPostalCode | string | ||
RecipientEmail | string |
Required |
|
RecipientPhone | string | ||
GiftMembershipMessage | string | ||
MembershipLevel | string |
Required |
|
MembershipAmount | decimal number |
Required |
|
AdditionalDonationFundId | integer | ||
AdditionalDonationAmount | decimal number | ||
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", "RecipientFirstName": "sample string 2", "RecipientLastName": "sample string 3", "RecipientAddress1": "sample string 4", "RecipientAddress2": "sample string 5", "RecipientCity": "sample string 6", "RecipientStateId": "sample string 7", "RecipientCountryId": 8, "RecipientPostalCode": "sample string 9", "RecipientEmail": "sample string 10", "RecipientPhone": "sample string 11", "GiftMembershipMessage": "sample string 12", "MembershipLevel": "sample string 13", "MembershipAmount": 14.0, "AdditionalDonationFundId": 15, "AdditionalDonationAmount": 16.0, "Email": "sample string 17", "Phone": "sample string 18", "AdditionalFirstName": "sample string 19", "AdditionalLastName": "sample string 20", "AdditionalEmail": "sample string 21", "FirstName": "sample string 22", "LastName": "sample string 23", "Address1": "sample string 24", "Address2": "sample string 25", "City": "sample string 26", "StateId": "sample string 27", "CountryId": 28, "PostalCode": "sample string 29", "CreditCardNumber": "sample string 30", "CreditCardType": 31, "CreditCardName": "sample string 32", "CreditCardCVV": "sample string 33", "CreditCardExpirationMonth": 34, "CreditCardExpirationYear": 35, "StoredCreditCardId": 36, "SourceId": 37 }
application/xml, text/xml
Sample:
<GiftMembershipRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Contribution"> <Address1>sample string 24</Address1> <Address2>sample string 25</Address2> <City>sample string 26</City> <CountryId>28</CountryId> <CreditCardCVV>sample string 33</CreditCardCVV> <CreditCardExpirationMonth>34</CreditCardExpirationMonth> <CreditCardExpirationYear>35</CreditCardExpirationYear> <CreditCardName>sample string 32</CreditCardName> <CreditCardNumber>sample string 30</CreditCardNumber> <CreditCardType>31</CreditCardType> <FirstName>sample string 22</FirstName> <LastName>sample string 23</LastName> <PostalCode>sample string 29</PostalCode> <SourceId>37</SourceId> <StateId>sample string 27</StateId> <StoredCreditCardId>36</StoredCreditCardId> <AdditionalDonationAmount>16</AdditionalDonationAmount> <AdditionalDonationFundId>15</AdditionalDonationFundId> <AdditionalEmail>sample string 21</AdditionalEmail> <AdditionalFirstName>sample string 19</AdditionalFirstName> <AdditionalLastName>sample string 20</AdditionalLastName> <Email>sample string 17</Email> <MembershipAmount>14</MembershipAmount> <MembershipLevel>sample string 13</MembershipLevel> <Phone>sample string 18</Phone> <GiftMembershipMessage>sample string 12</GiftMembershipMessage> <RecipientAddress1>sample string 4</RecipientAddress1> <RecipientAddress2>sample string 5</RecipientAddress2> <RecipientCity>sample string 6</RecipientCity> <RecipientCountryId>8</RecipientCountryId> <RecipientEmail>sample string 10</RecipientEmail> <RecipientFirstName>sample string 2</RecipientFirstName> <RecipientLastName>sample string 3</RecipientLastName> <RecipientPhone>sample string 11</RecipientPhone> <RecipientPostalCode>sample string 9</RecipientPostalCode> <RecipientStateId>sample string 7</RecipientStateId> <SessionKey>sample string 1</SessionKey> </GiftMembershipRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ApiSuccessOfGiftMembershipResultName | Description | Type | Additional information |
---|---|---|---|
Success | boolean | ||
Data | GiftMembershipResult |
Response Formats
application/json
Sample:
{ "Success": true, "Data": { "MembershipDonationAdded": true, "AdditionalDonationAdded": true, "PurchaseCompleted": true, "OrderEmailSent": true, "OrderNumber": 5, "PrimaryAddressError": true, "NewSessionKey": "PvcVcgzxhK/DUMfC553pfea046wYqYmxvQXQjKJNMYdIPA7BhyPh6zmMDtVrzOfSfwJ5/yslsXnOH7CZ26dSs8VU14OLduTGLIGXlKq91PA=", "Error": [ "sample string 1", "sample string 2" ] } }
text/json
Sample:
{ "Success": true, "Data": { "MembershipDonationAdded": true, "AdditionalDonationAdded": true, "PurchaseCompleted": true, "OrderEmailSent": true, "OrderNumber": 5, "PrimaryAddressError": true, "NewSessionKey": "+mYyhuGAae7SOe0R5Kp/NtfmNtkD8VxUcA+X79N6w8ZoQN9gec46laEJDBM47b7KQSPK0/83VvG/P9rb5gMilh7mcgFyZBDiVVg91vDLxos=", "Error": [ "sample string 1", "sample string 2" ] } }
application/xml, text/xml
Sample:
<ApiSuccessOfGiftMembershipResultyx5QZ_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 7</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">5</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:AdditionalDonationAdded>true</d2p1:AdditionalDonationAdded> <d2p1:MembershipDonationAdded>true</d2p1:MembershipDonationAdded> </Data> </ApiSuccessOfGiftMembershipResultyx5QZ_PAX>