API Web Service

API

Click here for a complete list of operations.

UpdateWork_v4

Updates an existing work

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/UpdateWork_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>
    <UpdateWork_v4 xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <TaskId>int</TaskId>
      <Name>string</Name>
      <Description>string</Description>
      <MeetingDurationInMins>int</MeetingDurationInMins>
      <CategoryId>int</CategoryId>
      <TargetPlannedWorktimeInMinutes>int</TargetPlannedWorktimeInMinutes>
      <TargetStartDate>dateTime</TargetStartDate>
      <TargetEndDate>dateTime</TargetEndDate>
      <TargetCost>decimal</TargetCost>
      <isTaskForMobile>boolean</isTaskForMobile>
      <priority>int</priority>
      <autoCloseAfterXHours>int</autoCloseAfterXHours>
      <keepOriginalValuesIfNull>boolean</keepOriginalValuesIfNull>
      <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>
      <requiredClosedReasons>
        <AfterDate>dateTime</AfterDate>
        <AfterTimeInMins>int</AfterTimeInMins>
        <RepeatIntervalInMins>int</RepeatIntervalInMins>
        <RepeatingTimes>int</RepeatingTimes>
      </requiredClosedReasons>
    </UpdateWork_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>
    <UpdateWork_v4Response xmlns="http://jobctrl.com/">
      <UpdateWork_v4Result>OK or UnknownError or AuthCodeNotValid or AccessDenied or EmptyNameIsNotValid or InvalidCategoryId or TargetPlannedWorktimeInMinutesIsInvalid or InvalidTimeInterval or InvalidTargetCost or ParentTargetCostIsExceeded or ParentTargetPlannedWorkTimeIsExceeded or TotalChildrenTargetCostIsHigherThanTheSetValue or TotalChildrenTargetPlannedWorkTimeIsHigherThanTheSetValue or CannotStartBeforeParentTask or CannotFinishAfterParentTask or CannotStartAfterChildTask or CannotFinishBeforeChildTask or WorkPlannedTimeLessThanTotalAssignmentPlannedTime or CloseReasonRequiredTimeIsInvalid or InvalidPlannedPeriod</UpdateWork_v4Result>
    </UpdateWork_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: 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>
    <UpdateWork_v4 xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <TaskId>int</TaskId>
      <Name>string</Name>
      <Description>string</Description>
      <MeetingDurationInMins>int</MeetingDurationInMins>
      <CategoryId>int</CategoryId>
      <TargetPlannedWorktimeInMinutes>int</TargetPlannedWorktimeInMinutes>
      <TargetStartDate>dateTime</TargetStartDate>
      <TargetEndDate>dateTime</TargetEndDate>
      <TargetCost>decimal</TargetCost>
      <isTaskForMobile>boolean</isTaskForMobile>
      <priority>int</priority>
      <autoCloseAfterXHours>int</autoCloseAfterXHours>
      <keepOriginalValuesIfNull>boolean</keepOriginalValuesIfNull>
      <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>
      <requiredClosedReasons>
        <AfterDate>dateTime</AfterDate>
        <AfterTimeInMins>int</AfterTimeInMins>
        <RepeatIntervalInMins>int</RepeatIntervalInMins>
        <RepeatingTimes>int</RepeatingTimes>
      </requiredClosedReasons>
    </UpdateWork_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>
    <UpdateWork_v4Response xmlns="http://jobctrl.com/">
      <UpdateWork_v4Result>OK or UnknownError or AuthCodeNotValid or AccessDenied or EmptyNameIsNotValid or InvalidCategoryId or TargetPlannedWorktimeInMinutesIsInvalid or InvalidTimeInterval or InvalidTargetCost or ParentTargetCostIsExceeded or ParentTargetPlannedWorkTimeIsExceeded or TotalChildrenTargetCostIsHigherThanTheSetValue or TotalChildrenTargetPlannedWorkTimeIsHigherThanTheSetValue or CannotStartBeforeParentTask or CannotFinishAfterParentTask or CannotStartAfterChildTask or CannotFinishBeforeChildTask or WorkPlannedTimeLessThanTotalAssignmentPlannedTime or CloseReasonRequiredTimeIsInvalid or InvalidPlannedPeriod</UpdateWork_v4Result>
    </UpdateWork_v4Response>
  </soap12:Body>
</soap12:Envelope>