Sphere Web Service

Sphere

Click here for a complete list of operations.

GetOutlookContacts

Given the username & password, return all the individual contacts information that available to this user.

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

<?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>
    <GetOutlookContacts xmlns="https://www.kintera.com/services/">
      <username>string</username>
      <password>string</password>
      <segmentationFilter>string</segmentationFilter>
    </GetOutlookContacts>
  </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>
    <GetOutlookContactsResponse xmlns="https://www.kintera.com/services/">
      <GetOutlookContactsResult>
        <Contacts>
          <OutlookContact>
            <SupporterID>int</SupporterID>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <CompanyName>string</CompanyName>
            <Position>string</Position>
            <EmailAddress>string</EmailAddress>
            <BirthDate>string</BirthDate>
            <Gender>Unknow or Male or Female</Gender>
            <HomeAddress xsi:nil="true" />
            <PhoneNumber xsi:nil="true" />
            <SyncStatus>string</SyncStatus>
            <UpdatedBy>string</UpdatedBy>
            <DateCreated>dateTime</DateCreated>
            <DateUpdated>dateTime</DateUpdated>
            <OutlookSync>boolean</OutlookSync>
            <ValidSupporter>boolean</ValidSupporter>
            <RecordStatus>string</RecordStatus>
          </OutlookContact>
          <OutlookContact>
            <SupporterID>int</SupporterID>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <CompanyName>string</CompanyName>
            <Position>string</Position>
            <EmailAddress>string</EmailAddress>
            <BirthDate>string</BirthDate>
            <Gender>Unknow or Male or Female</Gender>
            <HomeAddress xsi:nil="true" />
            <PhoneNumber xsi:nil="true" />
            <SyncStatus>string</SyncStatus>
            <UpdatedBy>string</UpdatedBy>
            <DateCreated>dateTime</DateCreated>
            <DateUpdated>dateTime</DateUpdated>
            <OutlookSync>boolean</OutlookSync>
            <ValidSupporter>boolean</ValidSupporter>
            <RecordStatus>string</RecordStatus>
          </OutlookContact>
        </Contacts>
      </GetOutlookContactsResult>
    </GetOutlookContactsResponse>
  </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>
    <GetOutlookContacts xmlns="https://www.kintera.com/services/">
      <username>string</username>
      <password>string</password>
      <segmentationFilter>string</segmentationFilter>
    </GetOutlookContacts>
  </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>
    <GetOutlookContactsResponse xmlns="https://www.kintera.com/services/">
      <GetOutlookContactsResult>
        <Contacts>
          <OutlookContact>
            <SupporterID>int</SupporterID>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <CompanyName>string</CompanyName>
            <Position>string</Position>
            <EmailAddress>string</EmailAddress>
            <BirthDate>string</BirthDate>
            <Gender>Unknow or Male or Female</Gender>
            <HomeAddress xsi:nil="true" />
            <PhoneNumber xsi:nil="true" />
            <SyncStatus>string</SyncStatus>
            <UpdatedBy>string</UpdatedBy>
            <DateCreated>dateTime</DateCreated>
            <DateUpdated>dateTime</DateUpdated>
            <OutlookSync>boolean</OutlookSync>
            <ValidSupporter>boolean</ValidSupporter>
            <RecordStatus>string</RecordStatus>
          </OutlookContact>
          <OutlookContact>
            <SupporterID>int</SupporterID>
            <Title>string</Title>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <CompanyName>string</CompanyName>
            <Position>string</Position>
            <EmailAddress>string</EmailAddress>
            <BirthDate>string</BirthDate>
            <Gender>Unknow or Male or Female</Gender>
            <HomeAddress xsi:nil="true" />
            <PhoneNumber xsi:nil="true" />
            <SyncStatus>string</SyncStatus>
            <UpdatedBy>string</UpdatedBy>
            <DateCreated>dateTime</DateCreated>
            <DateUpdated>dateTime</DateUpdated>
            <OutlookSync>boolean</OutlookSync>
            <ValidSupporter>boolean</ValidSupporter>
            <RecordStatus>string</RecordStatus>
          </OutlookContact>
        </Contacts>
      </GetOutlookContactsResult>
    </GetOutlookContactsResponse>
  </soap12:Body>
</soap12:Envelope>