Sphere Web Service

Sphere

Click here for a complete list of operations.

SubmitFormFields

Submit field values back to Sphere. The values user selected/entered is keeped in the Value field of the FormField class. Other fields should keep untouched after getting from Sphere through the GetFormFields web method.

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/SubmitFormFields"

<?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>
    <SubmitFormFields xmlns="https://www.kintera.com/services/">
      <request>
        <SupporterID>string</SupporterID>
        <EventID>int</EventID>
        <FormID>int</FormID>
        <FieldCategories>
          <FieldCategory>None or Regular or RegularPlusDisabled or Login or SecurityQuestion or Segmentation or NewsLetter or BillingAddress</FieldCategory>
          <FieldCategory>None or Regular or RegularPlusDisabled or Login or SecurityQuestion or Segmentation or NewsLetter or BillingAddress</FieldCategory>
        </FieldCategories>
        <FieldValues>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
        </FieldValues>
        <AddParticipant>boolean</AddParticipant>
        <VisitorSource>
          <TypeID>int</TypeID>
          <SourceID>string</SourceID>
          <SourceTitle>string</SourceTitle>
          <SourceUrl>string</SourceUrl>
          <PromotionCode>string</PromotionCode>
        </VisitorSource>
        <SendConfirmationEmail>Always or NewLoginOnly</SendConfirmationEmail>
        <ActivityType>int</ActivityType>
      </request>
    </SubmitFormFields>
  </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>
    <SubmitFormFieldsResponse xmlns="https://www.kintera.com/services/">
      <SubmitFormFieldsResult>
        <SupporterID>string</SupporterID>
        <LoginID>string</LoginID>
        <SupporterActionID>int</SupporterActionID>
        <FieldErrorList>
          <FieldError>
            <FormFieldID>int</FormFieldID>
            <FormFieldName>string</FormFieldName>
            <ErrorMessage>string</ErrorMessage>
          </FieldError>
          <FieldError>
            <FormFieldID>int</FormFieldID>
            <FormFieldName>string</FormFieldName>
            <ErrorMessage>string</ErrorMessage>
          </FieldError>
        </FieldErrorList>
      </SubmitFormFieldsResult>
    </SubmitFormFieldsResponse>
  </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>
    <SubmitFormFields xmlns="https://www.kintera.com/services/">
      <request>
        <SupporterID>string</SupporterID>
        <EventID>int</EventID>
        <FormID>int</FormID>
        <FieldCategories>
          <FieldCategory>None or Regular or RegularPlusDisabled or Login or SecurityQuestion or Segmentation or NewsLetter or BillingAddress</FieldCategory>
          <FieldCategory>None or Regular or RegularPlusDisabled or Login or SecurityQuestion or Segmentation or NewsLetter or BillingAddress</FieldCategory>
        </FieldCategories>
        <FieldValues>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
        </FieldValues>
        <AddParticipant>boolean</AddParticipant>
        <VisitorSource>
          <TypeID>int</TypeID>
          <SourceID>string</SourceID>
          <SourceTitle>string</SourceTitle>
          <SourceUrl>string</SourceUrl>
          <PromotionCode>string</PromotionCode>
        </VisitorSource>
        <SendConfirmationEmail>Always or NewLoginOnly</SendConfirmationEmail>
        <ActivityType>int</ActivityType>
      </request>
    </SubmitFormFields>
  </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>
    <SubmitFormFieldsResponse xmlns="https://www.kintera.com/services/">
      <SubmitFormFieldsResult>
        <SupporterID>string</SupporterID>
        <LoginID>string</LoginID>
        <SupporterActionID>int</SupporterActionID>
        <FieldErrorList>
          <FieldError>
            <FormFieldID>int</FormFieldID>
            <FormFieldName>string</FormFieldName>
            <ErrorMessage>string</ErrorMessage>
          </FieldError>
          <FieldError>
            <FormFieldID>int</FormFieldID>
            <FormFieldName>string</FormFieldName>
            <ErrorMessage>string</ErrorMessage>
          </FieldError>
        </FieldErrorList>
      </SubmitFormFieldsResult>
    </SubmitFormFieldsResponse>
  </soap12:Body>
</soap12:Envelope>