Admin Web Service

Admin

Click here for a complete list of operations.

GetUsersContactBySearchPattern

Obtain up to 20 user contacts for a given account by a search pattern

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /Admin.asmx HTTP/1.1
Host: ws.interfax.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://interfax.net/Admin/GetUsersContactBySearchPattern"

<?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>
    <GetUsersContactBySearchPattern xmlns="http://interfax.net/Admin">
      <Username>string</Username>
      <Password>string</Password>
      <SearchPattern>string</SearchPattern>
    </GetUsersContactBySearchPattern>
  </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>
    <GetUsersContactBySearchPatternResponse xmlns="http://interfax.net/Admin">
      <GetUsersContactBySearchPatternResult>
        <Status>int</Status>
        <data>
          <UserContactInfo>
            <UserID>string</UserID>
            <ContactName>string</ContactName>
            <Email>string</Email>
          </UserContactInfo>
          <UserContactInfo>
            <UserID>string</UserID>
            <ContactName>string</ContactName>
            <Email>string</Email>
          </UserContactInfo>
        </data>
      </GetUsersContactBySearchPatternResult>
    </GetUsersContactBySearchPatternResponse>
  </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 /Admin.asmx HTTP/1.1
Host: ws.interfax.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>
    <GetUsersContactBySearchPattern xmlns="http://interfax.net/Admin">
      <Username>string</Username>
      <Password>string</Password>
      <SearchPattern>string</SearchPattern>
    </GetUsersContactBySearchPattern>
  </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>
    <GetUsersContactBySearchPatternResponse xmlns="http://interfax.net/Admin">
      <GetUsersContactBySearchPatternResult>
        <Status>int</Status>
        <data>
          <UserContactInfo>
            <UserID>string</UserID>
            <ContactName>string</ContactName>
            <Email>string</Email>
          </UserContactInfo>
          <UserContactInfo>
            <UserID>string</UserID>
            <ContactName>string</ContactName>
            <Email>string</Email>
          </UserContactInfo>
        </data>
      </GetUsersContactBySearchPatternResult>
    </GetUsersContactBySearchPatternResponse>
  </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 /Admin.asmx/GetUsersContactBySearchPattern?Username=string&Password=string&SearchPattern=string HTTP/1.1
Host: ws.interfax.net

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

<?xml version="1.0" encoding="utf-8"?>
<ResultOfArrayOfUserContactInfo xmlns="http://interfax.net/Admin">
  <Status>int</Status>
  <data>
    <UserContactInfo>
      <UserID>string</UserID>
      <ContactName>string</ContactName>
      <Email>string</Email>
    </UserContactInfo>
    <UserContactInfo>
      <UserID>string</UserID>
      <ContactName>string</ContactName>
      <Email>string</Email>
    </UserContactInfo>
  </data>
</ResultOfArrayOfUserContactInfo>

HTTP POST

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

POST /Admin.asmx/GetUsersContactBySearchPattern HTTP/1.1
Host: ws.interfax.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&Password=string&SearchPattern=string

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

<?xml version="1.0" encoding="utf-8"?>
<ResultOfArrayOfUserContactInfo xmlns="http://interfax.net/Admin">
  <Status>int</Status>
  <data>
    <UserContactInfo>
      <UserID>string</UserID>
      <ContactName>string</ContactName>
      <Email>string</Email>
    </UserContactInfo>
    <UserContactInfo>
      <UserID>string</UserID>
      <ContactName>string</ContactName>
      <Email>string</Email>
    </UserContactInfo>
  </data>
</ResultOfArrayOfUserContactInfo>

Parameter	Value
Username:
Password:
SearchPattern: