OnlineAPI Web Service

OnlineAPI

Click here for a complete list of operations.

GetCustomerLookup

To search customers

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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/GetCustomerLookup"

<?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>
    <GetCustomerLookup xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <customerInput>
        <CustomerNumber>string</CustomerNumber>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <CompanyName>string</CompanyName>
        <Phone>string</Phone>
        <Email>string</Email>
        <TaxID>string</TaxID>
        <Street>string</Street>
        <City>string</City>
        <State>string</State>
        <County>string</County>
        <Country>string</Country>
        <AccountNumber>string</AccountNumber>
      </customerInput>
    </GetCustomerLookup>
  </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>
    <GetCustomerLookupResponse xmlns="http://www.securefreedom.com/">
      <GetCustomerLookupResult>
        <ds>
          <xsd:schema>schema</xsd:schema>xml</ds>
      </GetCustomerLookupResult>
    </GetCustomerLookupResponse>
  </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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.bydesign.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:Body>
    <GetCustomerLookup xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <customerInput>
        <CustomerNumber>string</CustomerNumber>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <CompanyName>string</CompanyName>
        <Phone>string</Phone>
        <Email>string</Email>
        <TaxID>string</TaxID>
        <Street>string</Street>
        <City>string</City>
        <State>string</State>
        <County>string</County>
        <Country>string</Country>
        <AccountNumber>string</AccountNumber>
      </customerInput>
    </GetCustomerLookup>
  </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>
    <GetCustomerLookupResponse xmlns="http://www.securefreedom.com/">
      <GetCustomerLookupResult>
        <ds>
          <xsd:schema>schema</xsd:schema>xml</ds>
      </GetCustomerLookupResult>
    </GetCustomerLookupResponse>
  </soap12:Body>
</soap12:Envelope>