ContactService


Click here for a complete list of operations.

UpdateContactsByFilter

Update contacts by ContactFilter and ContactEditableData.

Params:
  • filter - ContactFilter. For details about filter see GetContactsByFilter method.
  • contactData - ContactEditableData. For details about contactData see UpdateContact method.
Result is array of ContactOperationResult. For details about ContactOperationResult see UpdateContact method.
Soap client faults:
  • SimilarExists - similar contact is allready exists. Contact similarity is detected by contact type, contact address, contact gateway and contact alert sending delay
  • WrongAlertDelay - wrong alert delay
  • WrongActivePeriodInterval - wrong contact activity period
  • WrongActiveDay - wrong contact activity days
  • WrongEmailFormat - specified report format is incorrect. See reportFormat field available values in EmailContact or EmailContactEditableData
  • WrongSmsGateway - wrong sms gateway specified. See GetSmsGateways for available gateways.
  • WrongIMGateway - wrong instant messaging gateway specified. See GetIMGateways for available gateways.
  • WrongContactType - wrong contact type specified. See GetContactTypes for available gateways.
  • Subscription error codes - see subscription service AddSubscriptions

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/UpdateContactsByFilter"

<?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>
    <UpdateContactsByFilter 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>
      <contactData>
        <id>guid</id>
        <name>string</name>
        <address>string</address>
        <alertDelay>int</alertDelay>
        <activePeriodStart>string</activePeriodStart>
        <activePeriodEnd>string</activePeriodEnd>
        <activeDays>
          <string>string</string>
          <string>string</string>
        </activeDays>
        <subscriptions>
          <Subscription>
            <alertTypes xsi:nil="true" />
            <reportTypes xsi:nil="true" />
            <taskIds xsi:nil="true" />
            <contactIds xsi:nil="true" />
          </Subscription>
          <Subscription>
            <alertTypes xsi:nil="true" />
            <reportTypes xsi:nil="true" />
            <taskIds xsi:nil="true" />
            <contactIds xsi:nil="true" />
          </Subscription>
        </subscriptions>
      </contactData>
    </UpdateContactsByFilter>
  </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>
    <UpdateContactsByFilterResponse xmlns="http://www.host-tracker.com/Services">
      <UpdateContactsByFilterResult>
        <ContactOperationResult>
          <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 xsi:nil="true" />
            <billingOverlimit xsi:nil="true" />
            <subscriptions xsi:nil="true" />
          </contact>
          <status>string</status>
        </ContactOperationResult>
        <ContactOperationResult>
          <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 xsi:nil="true" />
            <billingOverlimit xsi:nil="true" />
            <subscriptions xsi:nil="true" />
          </contact>
          <status>string</status>
        </ContactOperationResult>
      </UpdateContactsByFilterResult>
    </UpdateContactsByFilterResponse>
  </soap:Body>
</soap:Envelope>