Api Web Service

Api

Click here for a complete list of operations.

CreateContact

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

<?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>
    <CreateContact xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <parameters>
        <Contacts>
          <CreateContactParameters>
            <ContactId>long</ContactId>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <PrimaryEmailAddress>string</PrimaryEmailAddress>
            <PrimaryPhone>string</PrimaryPhone>
            <AddressStreet1>string</AddressStreet1>
            <AddressStreet2>string</AddressStreet2>
            <AddressCity>string</AddressCity>
            <AddressState>string</AddressState>
            <AddressPostalCode>string</AddressPostalCode>
            <AddressCountry>string</AddressCountry>
            <BirthDate>dateTime</BirthDate>
            <Gender>NO_VALUE or DEFAULT_VALUE or Male or Female or Unspecified</Gender>
            <ContactType>Organization or Person or Household</ContactType>
            <OrganizationName>string</OrganizationName>
            <OrganizationType>Undefined or None</OrganizationType>
            <PrefixId>int</PrefixId>
            <SuffixId>int</SuffixId>
            <EmailOptIn>boolean</EmailOptIn>
            <SyncType_Id>int</SyncType_Id>
            <SyncExternalId>string</SyncExternalId>
          </CreateContactParameters>
          <CreateContactParameters>
            <ContactId>long</ContactId>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <PrimaryEmailAddress>string</PrimaryEmailAddress>
            <PrimaryPhone>string</PrimaryPhone>
            <AddressStreet1>string</AddressStreet1>
            <AddressStreet2>string</AddressStreet2>
            <AddressCity>string</AddressCity>
            <AddressState>string</AddressState>
            <AddressPostalCode>string</AddressPostalCode>
            <AddressCountry>string</AddressCountry>
            <BirthDate>dateTime</BirthDate>
            <Gender>NO_VALUE or DEFAULT_VALUE or Male or Female or Unspecified</Gender>
            <ContactType>Organization or Person or Household</ContactType>
            <OrganizationName>string</OrganizationName>
            <OrganizationType>Undefined or None</OrganizationType>
            <PrefixId>int</PrefixId>
            <SuffixId>int</SuffixId>
            <EmailOptIn>boolean</EmailOptIn>
            <SyncType_Id>int</SyncType_Id>
            <SyncExternalId>string</SyncExternalId>
          </CreateContactParameters>
        </Contacts>
      </parameters>
    </CreateContact>
  </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>
    <CreateContactResponse xmlns="https://api.bisglobal.net/">
      <CreateContactResult />
    </CreateContactResponse>
  </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>
    <CreateContact xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <parameters>
        <Contacts>
          <CreateContactParameters>
            <ContactId>long</ContactId>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <PrimaryEmailAddress>string</PrimaryEmailAddress>
            <PrimaryPhone>string</PrimaryPhone>
            <AddressStreet1>string</AddressStreet1>
            <AddressStreet2>string</AddressStreet2>
            <AddressCity>string</AddressCity>
            <AddressState>string</AddressState>
            <AddressPostalCode>string</AddressPostalCode>
            <AddressCountry>string</AddressCountry>
            <BirthDate>dateTime</BirthDate>
            <Gender>NO_VALUE or DEFAULT_VALUE or Male or Female or Unspecified</Gender>
            <ContactType>Organization or Person or Household</ContactType>
            <OrganizationName>string</OrganizationName>
            <OrganizationType>Undefined or None</OrganizationType>
            <PrefixId>int</PrefixId>
            <SuffixId>int</SuffixId>
            <EmailOptIn>boolean</EmailOptIn>
            <SyncType_Id>int</SyncType_Id>
            <SyncExternalId>string</SyncExternalId>
          </CreateContactParameters>
          <CreateContactParameters>
            <ContactId>long</ContactId>
            <FirstName>string</FirstName>
            <MiddleName>string</MiddleName>
            <LastName>string</LastName>
            <PrimaryEmailAddress>string</PrimaryEmailAddress>
            <PrimaryPhone>string</PrimaryPhone>
            <AddressStreet1>string</AddressStreet1>
            <AddressStreet2>string</AddressStreet2>
            <AddressCity>string</AddressCity>
            <AddressState>string</AddressState>
            <AddressPostalCode>string</AddressPostalCode>
            <AddressCountry>string</AddressCountry>
            <BirthDate>dateTime</BirthDate>
            <Gender>NO_VALUE or DEFAULT_VALUE or Male or Female or Unspecified</Gender>
            <ContactType>Organization or Person or Household</ContactType>
            <OrganizationName>string</OrganizationName>
            <OrganizationType>Undefined or None</OrganizationType>
            <PrefixId>int</PrefixId>
            <SuffixId>int</SuffixId>
            <EmailOptIn>boolean</EmailOptIn>
            <SyncType_Id>int</SyncType_Id>
            <SyncExternalId>string</SyncExternalId>
          </CreateContactParameters>
        </Contacts>
      </parameters>
    </CreateContact>
  </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>
    <CreateContactResponse xmlns="https://api.bisglobal.net/">
      <CreateContactResult />
    </CreateContactResponse>
  </soap12:Body>
</soap12:Envelope>