Symphony API V1.0


Click here for a complete list of operations.

CheckEmailAddress

This method can be used to check if an email address exists for this symphony Account

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
emailAddress:

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 /API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Host: developer.sym-online.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://developer.sym-online.com/API/1_0/SOAP/CheckEmailAddress"

<?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>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>string</Timestamp>
      <Operation>string</Operation>
      <Signature>string</Signature>
      <APIKey>string</APIKey>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <CheckEmailAddress xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <emailAddress>string</emailAddress>
    </CheckEmailAddress>
  </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>
    <CheckEmailAddressResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <CheckEmailAddressResult>
        <ContactID>int</ContactID>
        <EmailAddress>string</EmailAddress>
      </CheckEmailAddressResult>
    </CheckEmailAddressResponse>
  </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 /API/1_0/SOAP/SymphonyAPI.asmx HTTP/1.1
Host: developer.sym-online.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>
    <AuthenticationHeader xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <Timestamp>string</Timestamp>
      <Operation>string</Operation>
      <Signature>string</Signature>
      <APIKey>string</APIKey>
    </AuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <CheckEmailAddress xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <emailAddress>string</emailAddress>
    </CheckEmailAddress>
  </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>
    <CheckEmailAddressResponse xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
      <CheckEmailAddressResult>
        <ContactID>int</ContactID>
        <EmailAddress>string</EmailAddress>
      </CheckEmailAddressResult>
    </CheckEmailAddressResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /API/1_0/SOAP/SymphonyAPI.asmx/CheckEmailAddress?emailAddress=string HTTP/1.1
Host: developer.sym-online.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CheckEmailAddressResponseModel xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <ContactID>int</ContactID>
  <EmailAddress>string</EmailAddress>
</CheckEmailAddressResponseModel>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /API/1_0/SOAP/SymphonyAPI.asmx/CheckEmailAddress HTTP/1.1
Host: developer.sym-online.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

emailAddress=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<CheckEmailAddressResponseModel xmlns="https://developer.sym-online.com/API/1_0/SOAP/">
  <ContactID>int</ContactID>
  <EmailAddress>string</EmailAddress>
</CheckEmailAddressResponseModel>