Contact Web Service


Click here for a complete list of operations.

SearchContacts

Search for contacts in a specific domain, with one search value. Returns max. 100 records.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
sessionID:
domainID:
searchOption:
searchValue:
sortOrder:
modifiedAfter:
active:
pageNumber:

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 /ws/Contact.asmx HTTP/1.1
Host: api.yukiworks.be
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.theyukicompany.com/SearchContacts"

<?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>
    <SearchContacts xmlns="http://www.theyukicompany.com/">
      <sessionID>string</sessionID>
      <domainID>string</domainID>
      <searchOption>All or Name or City or Postcode or Tag or Email or Website or Phone or Code or CoCNumber or VATNumber or BankAccount or ID</searchOption>
      <searchValue>string</searchValue>
      <sortOrder>Name or LastName or CreatedAsc or CreatedDesc or ModifiedAsc or ModifiedDesc or HID</sortOrder>
      <modifiedAfter>dateTime</modifiedAfter>
      <active>Both or Active or Inactive</active>
      <pageNumber>int</pageNumber>
    </SearchContacts>
  </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>
    <SearchContactsResponse xmlns="http://www.theyukicompany.com/">
      <SearchContactsResult>xml</SearchContactsResult>
    </SearchContactsResponse>
  </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 /ws/Contact.asmx HTTP/1.1
Host: api.yukiworks.be
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>
    <SearchContacts xmlns="http://www.theyukicompany.com/">
      <sessionID>string</sessionID>
      <domainID>string</domainID>
      <searchOption>All or Name or City or Postcode or Tag or Email or Website or Phone or Code or CoCNumber or VATNumber or BankAccount or ID</searchOption>
      <searchValue>string</searchValue>
      <sortOrder>Name or LastName or CreatedAsc or CreatedDesc or ModifiedAsc or ModifiedDesc or HID</sortOrder>
      <modifiedAfter>dateTime</modifiedAfter>
      <active>Both or Active or Inactive</active>
      <pageNumber>int</pageNumber>
    </SearchContacts>
  </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>
    <SearchContactsResponse xmlns="http://www.theyukicompany.com/">
      <SearchContactsResult>xml</SearchContactsResult>
    </SearchContactsResponse>
  </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 /ws/Contact.asmx/SearchContacts?sessionID=string&domainID=string&searchOption=string&searchValue=string&sortOrder=string&modifiedAfter=string&active=string&pageNumber=string HTTP/1.1
Host: api.yukiworks.be
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0"?>
xml

HTTP POST

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

POST /ws/Contact.asmx/SearchContacts HTTP/1.1
Host: api.yukiworks.be
Content-Type: application/x-www-form-urlencoded
Content-Length: length

sessionID=string&domainID=string&searchOption=string&searchValue=string&sortOrder=string&modifiedAfter=string&active=string&pageNumber=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0"?>
xml