Sphere Web Service

Sphere

Click here for a complete list of operations.

GetDonationSettings

Get donation related settings: Pledge levels, Accepted credit cards, Show logo cards, and/or Event products.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /services/Sphere.asmx HTTP/1.1
Host: www.kintera.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://www.kintera.com/services/GetDonationSettings"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <KinteraSoapHeader xmlns="https://www.kintera.com/services/">
      <AccountID>int</AccountID>
      <SecurityToken>string</SecurityToken>
    </KinteraSoapHeader>
  </soap:Header>
  <soap:Body>
    <GetDonationSettings xmlns="https://www.kintera.com/services/">
      <request>
        <EventID>int</EventID>
        <DonationSettingCategories>
          <DonationSettingCategory>None or PledgeLevels or AcceptCreditCards or ShowLogoCards or EventProducts or Currency</DonationSettingCategory>
          <DonationSettingCategory>None or PledgeLevels or AcceptCreditCards or ShowLogoCards or EventProducts or Currency</DonationSettingCategory>
        </DonationSettingCategories>
      </request>
    </GetDonationSettings>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetDonationSettingsResponse xmlns="https://www.kintera.com/services/">
      <GetDonationSettingsResult>
        <PledgeLevels>
          <PledgeLevel>
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <MinimumAmount>decimal</MinimumAmount>
          </PledgeLevel>
          <PledgeLevel>
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <MinimumAmount>decimal</MinimumAmount>
          </PledgeLevel>
        </PledgeLevels>
        <CreditCardsList>string</CreditCardsList>
        <ShowLogoCardsList>string</ShowLogoCardsList>
        <Products>
          <Product>
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <PictureUrl>string</PictureUrl>
            <Price>decimal</Price>
          </Product>
          <Product>
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <PictureUrl>string</PictureUrl>
            <Price>decimal</Price>
          </Product>
        </Products>
        <RecurringDonation>boolean</RecurringDonation>
        <Currency>
          <Name>string</Name>
          <Symbol>string</Symbol>
          <Owner>string</Owner>
        </Currency>
        <CVVCheck>boolean</CVVCheck>
      </GetDonationSettingsResult>
    </GetDonationSettingsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /services/Sphere.asmx HTTP/1.1
Host: www.kintera.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <KinteraSoapHeader xmlns="https://www.kintera.com/services/">
      <AccountID>int</AccountID>
      <SecurityToken>string</SecurityToken>
    </KinteraSoapHeader>
  </soap12:Header>
  <soap12:Body>
    <GetDonationSettings xmlns="https://www.kintera.com/services/">
      <request>
        <EventID>int</EventID>
        <DonationSettingCategories>
          <DonationSettingCategory>None or PledgeLevels or AcceptCreditCards or ShowLogoCards or EventProducts or Currency</DonationSettingCategory>
          <DonationSettingCategory>None or PledgeLevels or AcceptCreditCards or ShowLogoCards or EventProducts or Currency</DonationSettingCategory>
        </DonationSettingCategories>
      </request>
    </GetDonationSettings>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetDonationSettingsResponse xmlns="https://www.kintera.com/services/">
      <GetDonationSettingsResult>
        <PledgeLevels>
          <PledgeLevel>
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <MinimumAmount>decimal</MinimumAmount>
          </PledgeLevel>
          <PledgeLevel>
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <MinimumAmount>decimal</MinimumAmount>
          </PledgeLevel>
        </PledgeLevels>
        <CreditCardsList>string</CreditCardsList>
        <ShowLogoCardsList>string</ShowLogoCardsList>
        <Products>
          <Product>
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <PictureUrl>string</PictureUrl>
            <Price>decimal</Price>
          </Product>
          <Product>
            <ID>int</ID>
            <Name>string</Name>
            <Description>string</Description>
            <PictureUrl>string</PictureUrl>
            <Price>decimal</Price>
          </Product>
        </Products>
        <RecurringDonation>boolean</RecurringDonation>
        <Currency>
          <Name>string</Name>
          <Symbol>string</Symbol>
          <Owner>string</Owner>
        </Currency>
        <CVVCheck>boolean</CVVCheck>
      </GetDonationSettingsResult>
    </GetDonationSettingsResponse>
  </soap12:Body>
</soap12:Envelope>