Api

Click here for a complete list of operations.

GetContacts

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 /v/2/Api.asmx HTTP/1.1
Host: api.charityengine.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.bisglobal.net/GetContacts"

<?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>
    <GetContacts xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <Contact_Id>long</Contact_Id>
        <ContactType_Id>int</ContactType_Id>
        <ContactStatus_Id>int</ContactStatus_Id>
        <ContactPriority_Id>int</ContactPriority_Id>
        <OrganizationType_Id>int</OrganizationType_Id>
        <OrganizationName>string</OrganizationName>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <EmailAddress>string</EmailAddress>
        <PhoneNumber>string</PhoneNumber>
        <AddressCity>string</AddressCity>
        <AddressStateProvince_Id>int</AddressStateProvince_Id>
        <AddressPostalCode>string</AddressPostalCode>
        <AddressCountry_Id>int</AddressCountry_Id>
        <ContactEmailOptIn>boolean</ContactEmailOptIn>
        <ContactPhoneOptIn>boolean</ContactPhoneOptIn>
        <ContactMailOptIn>boolean</ContactMailOptIn>
        <CampaignInitiative_Id>long</CampaignInitiative_Id>
        <ResponseChannel_Id>long</ResponseChannel_Id>
        <SyncType_Id>int</SyncType_Id>
        <SyncExternalId>string</SyncExternalId>
        <DateCreated_From>dateTime</DateCreated_From>
        <DateCreated_To>dateTime</DateCreated_To>
        <DateModified_From>dateTime</DateModified_From>
        <DateModified_To>dateTime</DateModified_To>
      </queryParameters>
    </GetContacts>
  </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>
    <GetContactsResponse xmlns="https://api.bisglobal.net/">
      <GetContactsResult>
        <AuthenticationContext_Id>long</AuthenticationContext_Id>
        <Contacts>
          <ContactRecord>
            <Contact_Id>long</Contact_Id>
            <ContactType>Organization or Person or Household</ContactType>
            <Status xsi:nil="true" />
            <Priority xsi:nil="true" />
            <ReceiveMail>boolean</ReceiveMail>
            <ReceiveEmail>boolean</ReceiveEmail>
            <ReceivePhoneCalls>boolean</ReceivePhoneCalls>
            <ReceiveSMS>boolean</ReceiveSMS>
            <ReceiveFax>boolean</ReceiveFax>
            <Salutation xsi:nil="true" />
            <ContactFullName>string</ContactFullName>
            <PersonDetail xsi:nil="true" />
            <OrganizationDetail xsi:nil="true" />
            <PrimaryAddress xsi:nil="true" />
            <PrimaryEmailAddress xsi:nil="true" />
            <PrimaryPhoneNumber xsi:nil="true" />
            <PrimaryRelationshipContact_Id>long</PrimaryRelationshipContact_Id>
            <PrimaryRelationshipName>string</PrimaryRelationshipName>
            <AcquisitionInitiative xsi:nil="true" />
            <SyncDetail xsi:nil="true" />
            <HighestPreviousTransaction>double</HighestPreviousTransaction>
            <TotalTransactionAmount>double</TotalTransactionAmount>
            <FirstTransaction>dateTime</FirstTransaction>
            <MostRecentTransaction>dateTime</MostRecentTransaction>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
          </ContactRecord>
          <ContactRecord>
            <Contact_Id>long</Contact_Id>
            <ContactType>Organization or Person or Household</ContactType>
            <Status xsi:nil="true" />
            <Priority xsi:nil="true" />
            <ReceiveMail>boolean</ReceiveMail>
            <ReceiveEmail>boolean</ReceiveEmail>
            <ReceivePhoneCalls>boolean</ReceivePhoneCalls>
            <ReceiveSMS>boolean</ReceiveSMS>
            <ReceiveFax>boolean</ReceiveFax>
            <Salutation xsi:nil="true" />
            <ContactFullName>string</ContactFullName>
            <PersonDetail xsi:nil="true" />
            <OrganizationDetail xsi:nil="true" />
            <PrimaryAddress xsi:nil="true" />
            <PrimaryEmailAddress xsi:nil="true" />
            <PrimaryPhoneNumber xsi:nil="true" />
            <PrimaryRelationshipContact_Id>long</PrimaryRelationshipContact_Id>
            <PrimaryRelationshipName>string</PrimaryRelationshipName>
            <AcquisitionInitiative xsi:nil="true" />
            <SyncDetail xsi:nil="true" />
            <HighestPreviousTransaction>double</HighestPreviousTransaction>
            <TotalTransactionAmount>double</TotalTransactionAmount>
            <FirstTransaction>dateTime</FirstTransaction>
            <MostRecentTransaction>dateTime</MostRecentTransaction>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
          </ContactRecord>
        </Contacts>
      </GetContactsResult>
    </GetContactsResponse>
  </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 /v/2/Api.asmx HTTP/1.1
Host: api.charityengine.net
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>
    <GetContacts xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <Contact_Id>long</Contact_Id>
        <ContactType_Id>int</ContactType_Id>
        <ContactStatus_Id>int</ContactStatus_Id>
        <ContactPriority_Id>int</ContactPriority_Id>
        <OrganizationType_Id>int</OrganizationType_Id>
        <OrganizationName>string</OrganizationName>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <EmailAddress>string</EmailAddress>
        <PhoneNumber>string</PhoneNumber>
        <AddressCity>string</AddressCity>
        <AddressStateProvince_Id>int</AddressStateProvince_Id>
        <AddressPostalCode>string</AddressPostalCode>
        <AddressCountry_Id>int</AddressCountry_Id>
        <ContactEmailOptIn>boolean</ContactEmailOptIn>
        <ContactPhoneOptIn>boolean</ContactPhoneOptIn>
        <ContactMailOptIn>boolean</ContactMailOptIn>
        <CampaignInitiative_Id>long</CampaignInitiative_Id>
        <ResponseChannel_Id>long</ResponseChannel_Id>
        <SyncType_Id>int</SyncType_Id>
        <SyncExternalId>string</SyncExternalId>
        <DateCreated_From>dateTime</DateCreated_From>
        <DateCreated_To>dateTime</DateCreated_To>
        <DateModified_From>dateTime</DateModified_From>
        <DateModified_To>dateTime</DateModified_To>
      </queryParameters>
    </GetContacts>
  </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>
    <GetContactsResponse xmlns="https://api.bisglobal.net/">
      <GetContactsResult>
        <AuthenticationContext_Id>long</AuthenticationContext_Id>
        <Contacts>
          <ContactRecord>
            <Contact_Id>long</Contact_Id>
            <ContactType>Organization or Person or Household</ContactType>
            <Status xsi:nil="true" />
            <Priority xsi:nil="true" />
            <ReceiveMail>boolean</ReceiveMail>
            <ReceiveEmail>boolean</ReceiveEmail>
            <ReceivePhoneCalls>boolean</ReceivePhoneCalls>
            <ReceiveSMS>boolean</ReceiveSMS>
            <ReceiveFax>boolean</ReceiveFax>
            <Salutation xsi:nil="true" />
            <ContactFullName>string</ContactFullName>
            <PersonDetail xsi:nil="true" />
            <OrganizationDetail xsi:nil="true" />
            <PrimaryAddress xsi:nil="true" />
            <PrimaryEmailAddress xsi:nil="true" />
            <PrimaryPhoneNumber xsi:nil="true" />
            <PrimaryRelationshipContact_Id>long</PrimaryRelationshipContact_Id>
            <PrimaryRelationshipName>string</PrimaryRelationshipName>
            <AcquisitionInitiative xsi:nil="true" />
            <SyncDetail xsi:nil="true" />
            <HighestPreviousTransaction>double</HighestPreviousTransaction>
            <TotalTransactionAmount>double</TotalTransactionAmount>
            <FirstTransaction>dateTime</FirstTransaction>
            <MostRecentTransaction>dateTime</MostRecentTransaction>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
          </ContactRecord>
          <ContactRecord>
            <Contact_Id>long</Contact_Id>
            <ContactType>Organization or Person or Household</ContactType>
            <Status xsi:nil="true" />
            <Priority xsi:nil="true" />
            <ReceiveMail>boolean</ReceiveMail>
            <ReceiveEmail>boolean</ReceiveEmail>
            <ReceivePhoneCalls>boolean</ReceivePhoneCalls>
            <ReceiveSMS>boolean</ReceiveSMS>
            <ReceiveFax>boolean</ReceiveFax>
            <Salutation xsi:nil="true" />
            <ContactFullName>string</ContactFullName>
            <PersonDetail xsi:nil="true" />
            <OrganizationDetail xsi:nil="true" />
            <PrimaryAddress xsi:nil="true" />
            <PrimaryEmailAddress xsi:nil="true" />
            <PrimaryPhoneNumber xsi:nil="true" />
            <PrimaryRelationshipContact_Id>long</PrimaryRelationshipContact_Id>
            <PrimaryRelationshipName>string</PrimaryRelationshipName>
            <AcquisitionInitiative xsi:nil="true" />
            <SyncDetail xsi:nil="true" />
            <HighestPreviousTransaction>double</HighestPreviousTransaction>
            <TotalTransactionAmount>double</TotalTransactionAmount>
            <FirstTransaction>dateTime</FirstTransaction>
            <MostRecentTransaction>dateTime</MostRecentTransaction>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
          </ContactRecord>
        </Contacts>
      </GetContactsResult>
    </GetContactsResponse>
  </soap12:Body>
</soap12:Envelope>