API Web Service

API

Click here for a complete list of operations.

GetTasksOfUser_v4

Gets the currently open tasks for the given user

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

<?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>
    <GetTasksOfUser_v4 xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <UserId>int</UserId>
      <ReturnClosedTasks>boolean</ReturnClosedTasks>
    </GetTasksOfUser_v4>
  </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>
    <GetTasksOfUser_v4Response xmlns="http://jobctrl.com/">
      <GetTasksOfUser_v4Result>OK or UnknownError or AuthCodeNotValid</GetTasksOfUser_v4Result>
      <AssignedTasks>
        <Task_v4>
          <Id>int</Id>
          <Type>Root or Project or Work</Type>
          <Name>string</Name>
          <ParentId>int</ParentId>
          <ExtId>string</ExtId>
          <Children>
            <Task_v4 xsi:nil="true" />
            <Task_v4 xsi:nil="true" />
          </Children>
          <AssignedTo>
            <TaskAssignment_v4 xsi:nil="true" />
            <TaskAssignment_v4 xsi:nil="true" />
          </AssignedTo>
          <MeetingDurationInMins>int</MeetingDurationInMins>
          <IsTasksAutoAssigned>boolean</IsTasksAutoAssigned>
          <CategoryId>int</CategoryId>
          <ExtCategoryId>int</ExtCategoryId>
          <TemplateTaskId>int</TemplateTaskId>
          <IsForMobile>boolean</IsForMobile>
          <Status>Active or Closed or Planned</Status>
          <ClosedAt>dateTime</ClosedAt>
          <Version>long</Version>
          <Description>string</Description>
          <TargetCost>decimal</TargetCost>
          <TargetPlannedWorkTimeInMinutes>int</TargetPlannedWorkTimeInMinutes>
          <TargetStartDate>dateTime</TargetStartDate>
          <TargetEndDate>dateTime</TargetEndDate>
          <TaskPriority>int</TaskPriority>
          <TaxId>string</TaxId>
          <CloseAfterInactiveHours>int</CloseAfterInactiveHours>
          <PlannedPeriods>
            <TaskPlannedPeriod_v2 xsi:nil="true" />
            <TaskPlannedPeriod_v2 xsi:nil="true" />
          </PlannedPeriods>
          <IsDynamic>boolean</IsDynamic>
          <RequiredCloseReasons>
            <AfterDate>dateTime</AfterDate>
            <AfterTimeInMins>int</AfterTimeInMins>
            <RepeatIntervalInMins>int</RepeatIntervalInMins>
            <RepeatingTimes>int</RepeatingTimes>
          </RequiredCloseReasons>
        </Task_v4>
        <Task_v4>
          <Id>int</Id>
          <Type>Root or Project or Work</Type>
          <Name>string</Name>
          <ParentId>int</ParentId>
          <ExtId>string</ExtId>
          <Children>
            <Task_v4 xsi:nil="true" />
            <Task_v4 xsi:nil="true" />
          </Children>
          <AssignedTo>
            <TaskAssignment_v4 xsi:nil="true" />
            <TaskAssignment_v4 xsi:nil="true" />
          </AssignedTo>
          <MeetingDurationInMins>int</MeetingDurationInMins>
          <IsTasksAutoAssigned>boolean</IsTasksAutoAssigned>
          <CategoryId>int</CategoryId>
          <ExtCategoryId>int</ExtCategoryId>
          <TemplateTaskId>int</TemplateTaskId>
          <IsForMobile>boolean</IsForMobile>
          <Status>Active or Closed or Planned</Status>
          <ClosedAt>dateTime</ClosedAt>
          <Version>long</Version>
          <Description>string</Description>
          <TargetCost>decimal</TargetCost>
          <TargetPlannedWorkTimeInMinutes>int</TargetPlannedWorkTimeInMinutes>
          <TargetStartDate>dateTime</TargetStartDate>
          <TargetEndDate>dateTime</TargetEndDate>
          <TaskPriority>int</TaskPriority>
          <TaxId>string</TaxId>
          <CloseAfterInactiveHours>int</CloseAfterInactiveHours>
          <PlannedPeriods>
            <TaskPlannedPeriod_v2 xsi:nil="true" />
            <TaskPlannedPeriod_v2 xsi:nil="true" />
          </PlannedPeriods>
          <IsDynamic>boolean</IsDynamic>
          <RequiredCloseReasons>
            <AfterDate>dateTime</AfterDate>
            <AfterTimeInMins>int</AfterTimeInMins>
            <RepeatIntervalInMins>int</RepeatIntervalInMins>
            <RepeatingTimes>int</RepeatingTimes>
          </RequiredCloseReasons>
        </Task_v4>
      </AssignedTasks>
    </GetTasksOfUser_v4Response>
  </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>
    <GetTasksOfUser_v4 xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <UserId>int</UserId>
      <ReturnClosedTasks>boolean</ReturnClosedTasks>
    </GetTasksOfUser_v4>
  </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>
    <GetTasksOfUser_v4Response xmlns="http://jobctrl.com/">
      <GetTasksOfUser_v4Result>OK or UnknownError or AuthCodeNotValid</GetTasksOfUser_v4Result>
      <AssignedTasks>
        <Task_v4>
          <Id>int</Id>
          <Type>Root or Project or Work</Type>
          <Name>string</Name>
          <ParentId>int</ParentId>
          <ExtId>string</ExtId>
          <Children>
            <Task_v4 xsi:nil="true" />
            <Task_v4 xsi:nil="true" />
          </Children>
          <AssignedTo>
            <TaskAssignment_v4 xsi:nil="true" />
            <TaskAssignment_v4 xsi:nil="true" />
          </AssignedTo>
          <MeetingDurationInMins>int</MeetingDurationInMins>
          <IsTasksAutoAssigned>boolean</IsTasksAutoAssigned>
          <CategoryId>int</CategoryId>
          <ExtCategoryId>int</ExtCategoryId>
          <TemplateTaskId>int</TemplateTaskId>
          <IsForMobile>boolean</IsForMobile>
          <Status>Active or Closed or Planned</Status>
          <ClosedAt>dateTime</ClosedAt>
          <Version>long</Version>
          <Description>string</Description>
          <TargetCost>decimal</TargetCost>
          <TargetPlannedWorkTimeInMinutes>int</TargetPlannedWorkTimeInMinutes>
          <TargetStartDate>dateTime</TargetStartDate>
          <TargetEndDate>dateTime</TargetEndDate>
          <TaskPriority>int</TaskPriority>
          <TaxId>string</TaxId>
          <CloseAfterInactiveHours>int</CloseAfterInactiveHours>
          <PlannedPeriods>
            <TaskPlannedPeriod_v2 xsi:nil="true" />
            <TaskPlannedPeriod_v2 xsi:nil="true" />
          </PlannedPeriods>
          <IsDynamic>boolean</IsDynamic>
          <RequiredCloseReasons>
            <AfterDate>dateTime</AfterDate>
            <AfterTimeInMins>int</AfterTimeInMins>
            <RepeatIntervalInMins>int</RepeatIntervalInMins>
            <RepeatingTimes>int</RepeatingTimes>
          </RequiredCloseReasons>
        </Task_v4>
        <Task_v4>
          <Id>int</Id>
          <Type>Root or Project or Work</Type>
          <Name>string</Name>
          <ParentId>int</ParentId>
          <ExtId>string</ExtId>
          <Children>
            <Task_v4 xsi:nil="true" />
            <Task_v4 xsi:nil="true" />
          </Children>
          <AssignedTo>
            <TaskAssignment_v4 xsi:nil="true" />
            <TaskAssignment_v4 xsi:nil="true" />
          </AssignedTo>
          <MeetingDurationInMins>int</MeetingDurationInMins>
          <IsTasksAutoAssigned>boolean</IsTasksAutoAssigned>
          <CategoryId>int</CategoryId>
          <ExtCategoryId>int</ExtCategoryId>
          <TemplateTaskId>int</TemplateTaskId>
          <IsForMobile>boolean</IsForMobile>
          <Status>Active or Closed or Planned</Status>
          <ClosedAt>dateTime</ClosedAt>
          <Version>long</Version>
          <Description>string</Description>
          <TargetCost>decimal</TargetCost>
          <TargetPlannedWorkTimeInMinutes>int</TargetPlannedWorkTimeInMinutes>
          <TargetStartDate>dateTime</TargetStartDate>
          <TargetEndDate>dateTime</TargetEndDate>
          <TaskPriority>int</TaskPriority>
          <TaxId>string</TaxId>
          <CloseAfterInactiveHours>int</CloseAfterInactiveHours>
          <PlannedPeriods>
            <TaskPlannedPeriod_v2 xsi:nil="true" />
            <TaskPlannedPeriod_v2 xsi:nil="true" />
          </PlannedPeriods>
          <IsDynamic>boolean</IsDynamic>
          <RequiredCloseReasons>
            <AfterDate>dateTime</AfterDate>
            <AfterTimeInMins>int</AfterTimeInMins>
            <RepeatIntervalInMins>int</RepeatIntervalInMins>
            <RepeatingTimes>int</RepeatingTimes>
          </RequiredCloseReasons>
        </Task_v4>
      </AssignedTasks>
    </GetTasksOfUser_v4Response>
  </soap12:Body>
</soap12:Envelope>