Sphere Web Service

Sphere

Click here for a complete list of operations.

GetFormFields

Get all event form fields. If EventID is not specified, it will return all the account form fields.

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

<?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>
    <GetFormFields xmlns="https://www.kintera.com/services/">
      <request>
        <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>
        <SupporterID>string</SupporterID>
      </request>
    </GetFormFields>
  </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>
    <GetFormFieldsResponse xmlns="https://www.kintera.com/services/">
      <GetFormFieldsResult>
        <FieldList>
          <FormField>
            <ID>int</ID>
            <Name>string</Name>
            <DisplayName>string</DisplayName>
            <Category>string</Category>
            <Context>Supporter or Transaction or Advocacy or Segmentation or Login or NewsLetter</Context>
            <FieldType>TextBox or TextArea or Password or RadioButton or CheckBox or CheckBoxList or DropDownList or ListBox or File</FieldType>
            <DataType>Text or DateTime or Number or Currency</DataType>
            <Length>int</Length>
            <SortKey>decimal</SortKey>
            <Status>Disabled or Deleted or Available or Required</Status>
            <CustomField>boolean</CustomField>
            <OrganizationField>boolean</OrganizationField>
            <ValueList>string</ValueList>
            <Value>string</Value>
            <MetaData xsi:nil="true" />
          </FormField>
          <FormField>
            <ID>int</ID>
            <Name>string</Name>
            <DisplayName>string</DisplayName>
            <Category>string</Category>
            <Context>Supporter or Transaction or Advocacy or Segmentation or Login or NewsLetter</Context>
            <FieldType>TextBox or TextArea or Password or RadioButton or CheckBox or CheckBoxList or DropDownList or ListBox or File</FieldType>
            <DataType>Text or DateTime or Number or Currency</DataType>
            <Length>int</Length>
            <SortKey>decimal</SortKey>
            <Status>Disabled or Deleted or Available or Required</Status>
            <CustomField>boolean</CustomField>
            <OrganizationField>boolean</OrganizationField>
            <ValueList>string</ValueList>
            <Value>string</Value>
            <MetaData xsi:nil="true" />
          </FormField>
        </FieldList>
      </GetFormFieldsResult>
    </GetFormFieldsResponse>
  </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>
    <GetFormFields xmlns="https://www.kintera.com/services/">
      <request>
        <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>
        <SupporterID>string</SupporterID>
      </request>
    </GetFormFields>
  </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>
    <GetFormFieldsResponse xmlns="https://www.kintera.com/services/">
      <GetFormFieldsResult>
        <FieldList>
          <FormField>
            <ID>int</ID>
            <Name>string</Name>
            <DisplayName>string</DisplayName>
            <Category>string</Category>
            <Context>Supporter or Transaction or Advocacy or Segmentation or Login or NewsLetter</Context>
            <FieldType>TextBox or TextArea or Password or RadioButton or CheckBox or CheckBoxList or DropDownList or ListBox or File</FieldType>
            <DataType>Text or DateTime or Number or Currency</DataType>
            <Length>int</Length>
            <SortKey>decimal</SortKey>
            <Status>Disabled or Deleted or Available or Required</Status>
            <CustomField>boolean</CustomField>
            <OrganizationField>boolean</OrganizationField>
            <ValueList>string</ValueList>
            <Value>string</Value>
            <MetaData xsi:nil="true" />
          </FormField>
          <FormField>
            <ID>int</ID>
            <Name>string</Name>
            <DisplayName>string</DisplayName>
            <Category>string</Category>
            <Context>Supporter or Transaction or Advocacy or Segmentation or Login or NewsLetter</Context>
            <FieldType>TextBox or TextArea or Password or RadioButton or CheckBox or CheckBoxList or DropDownList or ListBox or File</FieldType>
            <DataType>Text or DateTime or Number or Currency</DataType>
            <Length>int</Length>
            <SortKey>decimal</SortKey>
            <Status>Disabled or Deleted or Available or Required</Status>
            <CustomField>boolean</CustomField>
            <OrganizationField>boolean</OrganizationField>
            <ValueList>string</ValueList>
            <Value>string</Value>
            <MetaData xsi:nil="true" />
          </FormField>
        </FieldList>
      </GetFormFieldsResult>
    </GetFormFieldsResponse>
  </soap12:Body>
</soap12:Envelope>