API Web Service

API

Click here for a complete list of operations.

GetTaskHistory

Gets history of tasks or projects.

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/api.asmx HTTP/1.1
Host: jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/GetTaskHistory"

<?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>
    <GetTaskHistory xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <TaskId>int</TaskId>
    </GetTaskHistory>
  </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>
    <GetTaskHistoryResponse xmlns="http://jobctrl.com/">
      <GetTaskHistoryResult>OK or UnknownError or AuthCodeNotValid or AccessDenied</GetTaskHistoryResult>
      <History>
        <TaskHistory>
          <ChangedAt>dateTime</ChangedAt>
          <ChangedBy>int</ChangedBy>
          <ParentIdChanged>boolean</ParentIdChanged>
          <NameChanged>boolean</NameChanged>
          <NameWithCompletePathChanged>boolean</NameWithCompletePathChanged>
          <TargetStartDateChanged>boolean</TargetStartDateChanged>
          <TargetEndDateChanged>boolean</TargetEndDateChanged>
          <TaskPriorityChanged>boolean</TaskPriorityChanged>
          <TargetCostChanged>boolean</TargetCostChanged>
          <TargetPlannedWorkTimeInMinutesChanged>boolean</TargetPlannedWorkTimeInMinutesChanged>
          <TaxIdChanged>boolean</TaxIdChanged>
          <MeetingDurationInMinsChanged>boolean</MeetingDurationInMinsChanged>
          <CloseAfterInactiveHoursChanged>boolean</CloseAfterInactiveHoursChanged>
          <CategoryIdChanged>boolean</CategoryIdChanged>
          <VisibilityTypeChanged>boolean</VisibilityTypeChanged>
          <IsForMobileChanged>boolean</IsForMobileChanged>
          <DescriptionChanged>boolean</DescriptionChanged>
          <StatusChanged>boolean</StatusChanged>
          <ExtIdChanged>boolean</ExtIdChanged>
        </TaskHistory>
        <TaskHistory>
          <ChangedAt>dateTime</ChangedAt>
          <ChangedBy>int</ChangedBy>
          <ParentIdChanged>boolean</ParentIdChanged>
          <NameChanged>boolean</NameChanged>
          <NameWithCompletePathChanged>boolean</NameWithCompletePathChanged>
          <TargetStartDateChanged>boolean</TargetStartDateChanged>
          <TargetEndDateChanged>boolean</TargetEndDateChanged>
          <TaskPriorityChanged>boolean</TaskPriorityChanged>
          <TargetCostChanged>boolean</TargetCostChanged>
          <TargetPlannedWorkTimeInMinutesChanged>boolean</TargetPlannedWorkTimeInMinutesChanged>
          <TaxIdChanged>boolean</TaxIdChanged>
          <MeetingDurationInMinsChanged>boolean</MeetingDurationInMinsChanged>
          <CloseAfterInactiveHoursChanged>boolean</CloseAfterInactiveHoursChanged>
          <CategoryIdChanged>boolean</CategoryIdChanged>
          <VisibilityTypeChanged>boolean</VisibilityTypeChanged>
          <IsForMobileChanged>boolean</IsForMobileChanged>
          <DescriptionChanged>boolean</DescriptionChanged>
          <StatusChanged>boolean</StatusChanged>
          <ExtIdChanged>boolean</ExtIdChanged>
        </TaskHistory>
      </History>
    </GetTaskHistoryResponse>
  </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 /api/api.asmx HTTP/1.1
Host: jobctrl.com
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>
    <GetTaskHistory xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <TaskId>int</TaskId>
    </GetTaskHistory>
  </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>
    <GetTaskHistoryResponse xmlns="http://jobctrl.com/">
      <GetTaskHistoryResult>OK or UnknownError or AuthCodeNotValid or AccessDenied</GetTaskHistoryResult>
      <History>
        <TaskHistory>
          <ChangedAt>dateTime</ChangedAt>
          <ChangedBy>int</ChangedBy>
          <ParentIdChanged>boolean</ParentIdChanged>
          <NameChanged>boolean</NameChanged>
          <NameWithCompletePathChanged>boolean</NameWithCompletePathChanged>
          <TargetStartDateChanged>boolean</TargetStartDateChanged>
          <TargetEndDateChanged>boolean</TargetEndDateChanged>
          <TaskPriorityChanged>boolean</TaskPriorityChanged>
          <TargetCostChanged>boolean</TargetCostChanged>
          <TargetPlannedWorkTimeInMinutesChanged>boolean</TargetPlannedWorkTimeInMinutesChanged>
          <TaxIdChanged>boolean</TaxIdChanged>
          <MeetingDurationInMinsChanged>boolean</MeetingDurationInMinsChanged>
          <CloseAfterInactiveHoursChanged>boolean</CloseAfterInactiveHoursChanged>
          <CategoryIdChanged>boolean</CategoryIdChanged>
          <VisibilityTypeChanged>boolean</VisibilityTypeChanged>
          <IsForMobileChanged>boolean</IsForMobileChanged>
          <DescriptionChanged>boolean</DescriptionChanged>
          <StatusChanged>boolean</StatusChanged>
          <ExtIdChanged>boolean</ExtIdChanged>
        </TaskHistory>
        <TaskHistory>
          <ChangedAt>dateTime</ChangedAt>
          <ChangedBy>int</ChangedBy>
          <ParentIdChanged>boolean</ParentIdChanged>
          <NameChanged>boolean</NameChanged>
          <NameWithCompletePathChanged>boolean</NameWithCompletePathChanged>
          <TargetStartDateChanged>boolean</TargetStartDateChanged>
          <TargetEndDateChanged>boolean</TargetEndDateChanged>
          <TaskPriorityChanged>boolean</TaskPriorityChanged>
          <TargetCostChanged>boolean</TargetCostChanged>
          <TargetPlannedWorkTimeInMinutesChanged>boolean</TargetPlannedWorkTimeInMinutesChanged>
          <TaxIdChanged>boolean</TaxIdChanged>
          <MeetingDurationInMinsChanged>boolean</MeetingDurationInMinsChanged>
          <CloseAfterInactiveHoursChanged>boolean</CloseAfterInactiveHoursChanged>
          <CategoryIdChanged>boolean</CategoryIdChanged>
          <VisibilityTypeChanged>boolean</VisibilityTypeChanged>
          <IsForMobileChanged>boolean</IsForMobileChanged>
          <DescriptionChanged>boolean</DescriptionChanged>
          <StatusChanged>boolean</StatusChanged>
          <ExtIdChanged>boolean</ExtIdChanged>
        </TaskHistory>
      </History>
    </GetTaskHistoryResponse>
  </soap12:Body>
</soap12:Envelope>