API


Click here for a complete list of operations.

CreateWork_v4

Creates a work under an existing 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: jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/CreateWork_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>
    <CreateWork_v4 xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <ParentProjectId>int</ParentProjectId>
      <Name>string</Name>
      <Description>string</Description>
      <AutoAssignParticipants>boolean</AutoAssignParticipants>
      <UserIdsToAssign>
        <int>int</int>
        <int>int</int>
      </UserIdsToAssign>
      <Priority>short</Priority>
      <AssignmentStartDate>dateTime</AssignmentStartDate>
      <AssignmentEndDate>dateTime</AssignmentEndDate>
      <AssignmentPlannedWorktimeInMinutes>int</AssignmentPlannedWorktimeInMinutes>
      <closeAfterInactiveHours>short</closeAfterInactiveHours>
      <requiredClosedReasons>
        <AfterDate>dateTime</AfterDate>
        <AfterTimeInMins>int</AfterTimeInMins>
        <RepeatIntervalInMins>int</RepeatIntervalInMins>
        <RepeatingTimes>int</RepeatingTimes>
      </requiredClosedReasons>
      <IsForMobile>boolean</IsForMobile>
      <visibility>None or HideInMenu or HideInRules or HideInAdhoc</visibility>
    </CreateWork_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>
    <CreateWork_v4Response xmlns="http://jobctrl.com/">
      <CreateWork_v4Result>OK or UnknownError or AuthCodeNotValid or AccessDenied or ParentMustBeProject or EmptyNameIsNotValid or InvalidTimeInterval or BothDatesMustBeSetToNullOrToValue or PriorityIsInvalid or PlannedWorktimeInMinutesIsInvalid or PlannedWorktimeInMinutesIsGreaterThanAllowedByStartdateAndEnddate or CloseReasonRequiredTimeIsInvalid or CannotStartBeforeParentTask or CannotFinishAfterParentTask</CreateWork_v4Result>
      <CreatedWorkId>int</CreatedWorkId>
    </CreateWork_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>
    <CreateWork_v4 xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <ParentProjectId>int</ParentProjectId>
      <Name>string</Name>
      <Description>string</Description>
      <AutoAssignParticipants>boolean</AutoAssignParticipants>
      <UserIdsToAssign>
        <int>int</int>
        <int>int</int>
      </UserIdsToAssign>
      <Priority>short</Priority>
      <AssignmentStartDate>dateTime</AssignmentStartDate>
      <AssignmentEndDate>dateTime</AssignmentEndDate>
      <AssignmentPlannedWorktimeInMinutes>int</AssignmentPlannedWorktimeInMinutes>
      <closeAfterInactiveHours>short</closeAfterInactiveHours>
      <requiredClosedReasons>
        <AfterDate>dateTime</AfterDate>
        <AfterTimeInMins>int</AfterTimeInMins>
        <RepeatIntervalInMins>int</RepeatIntervalInMins>
        <RepeatingTimes>int</RepeatingTimes>
      </requiredClosedReasons>
      <IsForMobile>boolean</IsForMobile>
      <visibility>None or HideInMenu or HideInRules or HideInAdhoc</visibility>
    </CreateWork_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>
    <CreateWork_v4Response xmlns="http://jobctrl.com/">
      <CreateWork_v4Result>OK or UnknownError or AuthCodeNotValid or AccessDenied or ParentMustBeProject or EmptyNameIsNotValid or InvalidTimeInterval or BothDatesMustBeSetToNullOrToValue or PriorityIsInvalid or PlannedWorktimeInMinutesIsInvalid or PlannedWorktimeInMinutesIsGreaterThanAllowedByStartdateAndEnddate or CloseReasonRequiredTimeIsInvalid or CannotStartBeforeParentTask or CannotFinishAfterParentTask</CreateWork_v4Result>
      <CreatedWorkId>int</CreatedWorkId>
    </CreateWork_v4Response>
  </soap12:Body>
</soap12:Envelope>