API Web Service

API

Click here for a complete list of operations.

ImportTaskSubTree

Imports a task subtree. It only creates and updates tasks and assignments. Deletion is not supported.

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

<?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>
    <ImportTaskSubTree xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <SubTreeRoot>
        <Id>int</Id>
        <Type>Root or Project or Work</Type>
        <Name>string</Name>
        <ParentId>int</ParentId>
        <ExtId>string</ExtId>
        <Children>
          <Task_v4>
            <Id>int</Id>
            <Type>Root or Project or Work</Type>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ExtId>string</ExtId>
            <Children xsi:nil="true" />
            <AssignedTo xsi:nil="true" />
            <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 xsi:nil="true" />
            <IsDynamic>boolean</IsDynamic>
            <RequiredCloseReasons xsi:nil="true" />
          </Task_v4>
          <Task_v4>
            <Id>int</Id>
            <Type>Root or Project or Work</Type>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ExtId>string</ExtId>
            <Children xsi:nil="true" />
            <AssignedTo xsi:nil="true" />
            <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 xsi:nil="true" />
            <IsDynamic>boolean</IsDynamic>
            <RequiredCloseReasons xsi:nil="true" />
          </Task_v4>
        </Children>
        <AssignedTo>
          <TaskAssignment_v4>
            <UserId>int</UserId>
            <ExtUserId>string</ExtUserId>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <PlannedWorkTimeInMinutes>int</PlannedWorkTimeInMinutes>
            <Status>Active or Closed or Planned</Status>
            <ClosedAt>dateTime</ClosedAt>
            <Version>long</Version>
          </TaskAssignment_v4>
          <TaskAssignment_v4>
            <UserId>int</UserId>
            <ExtUserId>string</ExtUserId>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <PlannedWorkTimeInMinutes>int</PlannedWorkTimeInMinutes>
            <Status>Active or Closed or Planned</Status>
            <ClosedAt>dateTime</ClosedAt>
            <Version>long</Version>
          </TaskAssignment_v4>
        </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>
            <PeriodId>int</PeriodId>
            <IsDefault>boolean</IsDefault>
            <Name>string</Name>
            <TargetCost>decimal</TargetCost>
            <TargetWorktimeInMinutes>int</TargetWorktimeInMinutes>
          </TaskPlannedPeriod_v2>
          <TaskPlannedPeriod_v2>
            <PeriodId>int</PeriodId>
            <IsDefault>boolean</IsDefault>
            <Name>string</Name>
            <TargetCost>decimal</TargetCost>
            <TargetWorktimeInMinutes>int</TargetWorktimeInMinutes>
          </TaskPlannedPeriod_v2>
        </PlannedPeriods>
        <IsDynamic>boolean</IsDynamic>
        <RequiredCloseReasons>
          <AfterDate>dateTime</AfterDate>
          <AfterTimeInMins>int</AfterTimeInMins>
          <RepeatIntervalInMins>int</RepeatIntervalInMins>
          <RepeatingTimes>int</RepeatingTimes>
        </RequiredCloseReasons>
      </SubTreeRoot>
    </ImportTaskSubTree>
  </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>
    <ImportTaskSubTreeResponse xmlns="http://jobctrl.com/">
      <ImportTaskSubTreeResult>
        <GeneralErrorCode>OK or UnknownError or AuthCodeNotValid or ErrorWithDetails</GeneralErrorCode>
        <Errors>
          <ImportTaskSubTreeError>
            <TaskId>int</TaskId>
            <UserId>int</UserId>
            <ErrorMessage>string</ErrorMessage>
          </ImportTaskSubTreeError>
          <ImportTaskSubTreeError>
            <TaskId>int</TaskId>
            <UserId>int</UserId>
            <ErrorMessage>string</ErrorMessage>
          </ImportTaskSubTreeError>
        </Errors>
      </ImportTaskSubTreeResult>
    </ImportTaskSubTreeResponse>
  </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>
    <ImportTaskSubTree xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <SubTreeRoot>
        <Id>int</Id>
        <Type>Root or Project or Work</Type>
        <Name>string</Name>
        <ParentId>int</ParentId>
        <ExtId>string</ExtId>
        <Children>
          <Task_v4>
            <Id>int</Id>
            <Type>Root or Project or Work</Type>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ExtId>string</ExtId>
            <Children xsi:nil="true" />
            <AssignedTo xsi:nil="true" />
            <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 xsi:nil="true" />
            <IsDynamic>boolean</IsDynamic>
            <RequiredCloseReasons xsi:nil="true" />
          </Task_v4>
          <Task_v4>
            <Id>int</Id>
            <Type>Root or Project or Work</Type>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ExtId>string</ExtId>
            <Children xsi:nil="true" />
            <AssignedTo xsi:nil="true" />
            <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 xsi:nil="true" />
            <IsDynamic>boolean</IsDynamic>
            <RequiredCloseReasons xsi:nil="true" />
          </Task_v4>
        </Children>
        <AssignedTo>
          <TaskAssignment_v4>
            <UserId>int</UserId>
            <ExtUserId>string</ExtUserId>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <PlannedWorkTimeInMinutes>int</PlannedWorkTimeInMinutes>
            <Status>Active or Closed or Planned</Status>
            <ClosedAt>dateTime</ClosedAt>
            <Version>long</Version>
          </TaskAssignment_v4>
          <TaskAssignment_v4>
            <UserId>int</UserId>
            <ExtUserId>string</ExtUserId>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <PlannedWorkTimeInMinutes>int</PlannedWorkTimeInMinutes>
            <Status>Active or Closed or Planned</Status>
            <ClosedAt>dateTime</ClosedAt>
            <Version>long</Version>
          </TaskAssignment_v4>
        </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>
            <PeriodId>int</PeriodId>
            <IsDefault>boolean</IsDefault>
            <Name>string</Name>
            <TargetCost>decimal</TargetCost>
            <TargetWorktimeInMinutes>int</TargetWorktimeInMinutes>
          </TaskPlannedPeriod_v2>
          <TaskPlannedPeriod_v2>
            <PeriodId>int</PeriodId>
            <IsDefault>boolean</IsDefault>
            <Name>string</Name>
            <TargetCost>decimal</TargetCost>
            <TargetWorktimeInMinutes>int</TargetWorktimeInMinutes>
          </TaskPlannedPeriod_v2>
        </PlannedPeriods>
        <IsDynamic>boolean</IsDynamic>
        <RequiredCloseReasons>
          <AfterDate>dateTime</AfterDate>
          <AfterTimeInMins>int</AfterTimeInMins>
          <RepeatIntervalInMins>int</RepeatIntervalInMins>
          <RepeatingTimes>int</RepeatingTimes>
        </RequiredCloseReasons>
      </SubTreeRoot>
    </ImportTaskSubTree>
  </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>
    <ImportTaskSubTreeResponse xmlns="http://jobctrl.com/">
      <ImportTaskSubTreeResult>
        <GeneralErrorCode>OK or UnknownError or AuthCodeNotValid or ErrorWithDetails</GeneralErrorCode>
        <Errors>
          <ImportTaskSubTreeError>
            <TaskId>int</TaskId>
            <UserId>int</UserId>
            <ErrorMessage>string</ErrorMessage>
          </ImportTaskSubTreeError>
          <ImportTaskSubTreeError>
            <TaskId>int</TaskId>
            <UserId>int</UserId>
            <ErrorMessage>string</ErrorMessage>
          </ImportTaskSubTreeError>
        </Errors>
      </ImportTaskSubTreeResult>
    </ImportTaskSubTreeResponse>
  </soap12:Body>
</soap12:Envelope>