ContactService


Click here for a complete list of operations.

ConfirmContacts

Confirm contacts via array of ContactConfirmation record.

Params:
  • codes - array of ContactConfirmation.
    ContactConfirmation:
    • id - id of contact to confirm
    • code - code for confirmation
Result is array of ContactOperationResult. For details about ContactOperationResult see CreateContact, UpdateContact methods.
Result contains new statuses for contacts. If confirmation succeeded then status will be Confirmed. If confirmation failed status well be CodeFail.

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

<?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>
    <ConfirmContacts xmlns="http://www.host-tracker.com/Services">
      <codes>
        <ContactConfirmation>
          <id>guid</id>
          <code>string</code>
        </ContactConfirmation>
        <ContactConfirmation>
          <id>guid</id>
          <code>string</code>
        </ContactConfirmation>
      </codes>
    </ConfirmContacts>
  </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>
    <ConfirmContactsResponse xmlns="http://www.host-tracker.com/Services">
      <ConfirmContactsResult>
        <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>
      </ConfirmContactsResult>
    </ConfirmContactsResponse>
  </soap:Body>
</soap:Envelope>