ContactService


Click here for a complete list of operations.

DeleteContactsByFilter

Delete contact by specified ContactFilter.

Params:
  • filter - ContactFilter. For details about filter see GetContactsByFilter method.
Result is void (unit, none).
Soap client faults:
  • WrongContactType - specified wrong contact type in filter

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 /api/soap/v1/contact.asmx HTTP/1.1
Host: www.host-tracker.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.host-tracker.com/Services/DeleteContactsByFilter"

<?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>
    <AuthHeader xmlns="http://www.host-tracker.com/Services">
      <login>string</login>
      <password>string</password>
      <ticket>string</ticket>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <DeleteContactsByFilter xmlns="http://www.host-tracker.com/Services">
      <filter>
        <id>guid</id>
        <ids>
          <guid>guid</guid>
          <guid>guid</guid>
        </ids>
        <excludeIds>boolean</excludeIds>
        <contactType>string</contactType>
        <contactTypes>
          <string>string</string>
          <string>string</string>
        </contactTypes>
        <excludeContactTypes>boolean</excludeContactTypes>
        <confirmed>boolean</confirmed>
        <overlimited>boolean</overlimited>
        <acceptBillingNotifications>boolean</acceptBillingNotifications>
        <name>string</name>
        <names>
          <string>string</string>
          <string>string</string>
        </names>
        <nameSearchLike>boolean</nameSearchLike>
        <excludeNames>boolean</excludeNames>
        <address>string</address>
        <addresses>
          <string>string</string>
          <string>string</string>
        </addresses>
        <addressSearchLike>boolean</addressSearchLike>
        <excludeAddresses>boolean</excludeAddresses>
      </filter>
    </DeleteContactsByFilter>
  </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>
    <DeleteContactsByFilterResponse xmlns="http://www.host-tracker.com/Services">
      <DeleteContactsByFilterResult>
        <Contact>
          <id>guid</id>
          <confirmed>boolean</confirmed>
          <contactType>string</contactType>
          <name>string</name>
          <address>string</address>
          <sendCost>decimal</sendCost>
          <sendCostDirty>boolean</sendCostDirty>
          <alertDelay>int</alertDelay>
          <activePeriodStart>string</activePeriodStart>
          <activePeriodEnd>string</activePeriodEnd>
          <activeDays>
            <string>string</string>
            <string>string</string>
          </activeDays>
          <billingOverlimit>
            <string>string</string>
            <string>string</string>
          </billingOverlimit>
          <subscriptions>
            <Subscription xsi:nil="true" />
            <Subscription xsi:nil="true" />
          </subscriptions>
        </Contact>
        <Contact>
          <id>guid</id>
          <confirmed>boolean</confirmed>
          <contactType>string</contactType>
          <name>string</name>
          <address>string</address>
          <sendCost>decimal</sendCost>
          <sendCostDirty>boolean</sendCostDirty>
          <alertDelay>int</alertDelay>
          <activePeriodStart>string</activePeriodStart>
          <activePeriodEnd>string</activePeriodEnd>
          <activeDays>
            <string>string</string>
            <string>string</string>
          </activeDays>
          <billingOverlimit>
            <string>string</string>
            <string>string</string>
          </billingOverlimit>
          <subscriptions>
            <Subscription xsi:nil="true" />
            <Subscription xsi:nil="true" />
          </subscriptions>
        </Contact>
      </DeleteContactsByFilterResult>
    </DeleteContactsByFilterResponse>
  </soap:Body>
</soap:Envelope>