API Web Service

API

Click here for a complete list of operations.

GetTask

Gets a work or project.

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: kr.jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/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:Body>
    <GetTask xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <TaskId>int</TaskId>
      <IncludeClosedAssignments>boolean</IncludeClosedAssignments>
    </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://jobctrl.com/">
      <GetTaskResult>OK or UnknownError or AuthCodeNotValid or AccessDenied</GetTaskResult>
      <task>
        <Id>int</Id>
        <Type>Root or Project or Work</Type>
        <Name>string</Name>
        <ParentId>int</ParentId>
        <ExtId>int</ExtId>
        <Children>
          <Task_v2>
            <Id>int</Id>
            <Type>Root or Project or Work</Type>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ExtId>int</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>
            <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" />
          </Task_v2>
          <Task_v2>
            <Id>int</Id>
            <Type>Root or Project or Work</Type>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ExtId>int</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>
            <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" />
          </Task_v2>
        </Children>
        <AssignedTo>
          <TaskAssignment_v2>
            <UserId>int</UserId>
            <ExtUserId>int</ExtUserId>
            <Priority>int</Priority>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <PlannedWorkTimeInMinutes>int</PlannedWorkTimeInMinutes>
            <Status>Active or Closed or Planned</Status>
            <ClosedAt>dateTime</ClosedAt>
            <Version>long</Version>
          </TaskAssignment_v2>
          <TaskAssignment_v2>
            <UserId>int</UserId>
            <ExtUserId>int</ExtUserId>
            <Priority>int</Priority>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <PlannedWorkTimeInMinutes>int</PlannedWorkTimeInMinutes>
            <Status>Active or Closed or Planned</Status>
            <ClosedAt>dateTime</ClosedAt>
            <Version>long</Version>
          </TaskAssignment_v2>
        </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>
        <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>
      </task>
    </GetTaskResponse>
  </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: kr.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>
    <GetTask xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <TaskId>int</TaskId>
      <IncludeClosedAssignments>boolean</IncludeClosedAssignments>
    </GetTask>
  </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>
    <GetTaskResponse xmlns="http://jobctrl.com/">
      <GetTaskResult>OK or UnknownError or AuthCodeNotValid or AccessDenied</GetTaskResult>
      <task>
        <Id>int</Id>
        <Type>Root or Project or Work</Type>
        <Name>string</Name>
        <ParentId>int</ParentId>
        <ExtId>int</ExtId>
        <Children>
          <Task_v2>
            <Id>int</Id>
            <Type>Root or Project or Work</Type>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ExtId>int</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>
            <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" />
          </Task_v2>
          <Task_v2>
            <Id>int</Id>
            <Type>Root or Project or Work</Type>
            <Name>string</Name>
            <ParentId>int</ParentId>
            <ExtId>int</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>
            <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" />
          </Task_v2>
        </Children>
        <AssignedTo>
          <TaskAssignment_v2>
            <UserId>int</UserId>
            <ExtUserId>int</ExtUserId>
            <Priority>int</Priority>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <PlannedWorkTimeInMinutes>int</PlannedWorkTimeInMinutes>
            <Status>Active or Closed or Planned</Status>
            <ClosedAt>dateTime</ClosedAt>
            <Version>long</Version>
          </TaskAssignment_v2>
          <TaskAssignment_v2>
            <UserId>int</UserId>
            <ExtUserId>int</ExtUserId>
            <Priority>int</Priority>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <PlannedWorkTimeInMinutes>int</PlannedWorkTimeInMinutes>
            <Status>Active or Closed or Planned</Status>
            <ClosedAt>dateTime</ClosedAt>
            <Version>long</Version>
          </TaskAssignment_v2>
        </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>
        <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>
      </task>
    </GetTaskResponse>
  </soap12:Body>
</soap12:Envelope>