TaskService


Click here for a complete list of operations.

GetTask

Get task (HttpTask, PingTask, PortTask, ...) by id (GUID). Return null if task was not found.

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/task.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/GetTask"

<?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>
    <GetTask xmlns="http://www.host-tracker.com/Services">
      <id>guid</id>
      <additionalTaskInfo>None or Subscriptions or Stats</additionalTaskInfo>
    </GetTask>
  </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>
    <GetTaskResponse xmlns="http://www.host-tracker.com/Services">
      <GetTaskResult>
        <creationTime>dateTime</creationTime>
        <taskType>string</taskType>
        <enabled>boolean</enabled>
        <interval>int</interval>
        <upFromTime>dateTime</upFromTime>
        <lastState>boolean</lastState>
        <lastStateChangeTime>dateTime</lastStateChangeTime>
        <openStatEnabled>boolean</openStatEnabled>
        <fullLogEnabled>boolean</fullLogEnabled>
        <disablenceReason>string</disablenceReason>
        <disablenceTime>dateTime</disablenceTime>
        <holdResults>boolean</holdResults>
        <agentStat>boolean</agentStat>
        <billingOverlimits>
          <string>string</string>
          <string>string</string>
        </billingOverlimits>
        <tags>
          <string>string</string>
          <string>string</string>
        </tags>
        <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>
        <stats>
          <daily>double</daily>
          <monthly>double</monthly>
          <yearly>double</yearly>
          <total>double</total>
        </stats>
        <agentPools>
          <string>string</string>
          <string>string</string>
        </agentPools>
        <deleted>boolean</deleted>
        <dnsbl>
          <lastChecked>dateTime</lastChecked>
          <interval>int</interval>
          <lastState>boolean</lastState>
          <lastStateChangeTime>dateTime</lastStateChangeTime>
        </dnsbl>
      </GetTaskResult>
    </GetTaskResponse>
  </soap:Body>
</soap:Envelope>