API Web Service

API

Click here for a complete list of operations.

AddManualWorkitems

OBSOLETE - Adds manual workitems to the users of the company

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

<?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>
    <AddManualWorkitems xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <manualWorkItems>
        <APIManualWorkItem>
          <Id>int</Id>
          <ManualWorkItemType>ReplaceInterval or AddWork or DeleteInterval</ManualWorkItemType>
          <WorkId>int</WorkId>
          <SpecificTaskId>int</SpecificTaskId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <UserId>int</UserId>
          <CompanyId>int</CompanyId>
          <Comment>string</Comment>
          <CreateDate>dateTime</CreateDate>
          <CreatedBy>int</CreatedBy>
          <TaskName>string</TaskName>
          <TaskNameWithCompletePath>string</TaskNameWithCompletePath>
          <SpecificTaskNameWithCompletePath>string</SpecificTaskNameWithCompletePath>
          <RequestStatus>Requested or Approved or Rejected or Revoked or Deleted</RequestStatus>
        </APIManualWorkItem>
        <APIManualWorkItem>
          <Id>int</Id>
          <ManualWorkItemType>ReplaceInterval or AddWork or DeleteInterval</ManualWorkItemType>
          <WorkId>int</WorkId>
          <SpecificTaskId>int</SpecificTaskId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <UserId>int</UserId>
          <CompanyId>int</CompanyId>
          <Comment>string</Comment>
          <CreateDate>dateTime</CreateDate>
          <CreatedBy>int</CreatedBy>
          <TaskName>string</TaskName>
          <TaskNameWithCompletePath>string</TaskNameWithCompletePath>
          <SpecificTaskNameWithCompletePath>string</SpecificTaskNameWithCompletePath>
          <RequestStatus>Requested or Approved or Rejected or Revoked or Deleted</RequestStatus>
        </APIManualWorkItem>
      </manualWorkItems>
    </AddManualWorkitems>
  </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>
    <AddManualWorkitemsResponse xmlns="http://jobctrl.com/">
      <AddManualWorkitemsResult>OK or UnknownError or AuthCodeInvalid</AddManualWorkitemsResult>
      <errorsByRowIndex>
        <ManualWorkitemErrorWithIndex>
          <Index>int</Index>
          <Error>SubscriptionExpired or SpecificTaskIdIsInvalid or AccessDenied or UnknownError or OK or TimeIntervalIsOutdated or NodeDoesNotExist or CorrectionTypeIsNotValid or TaskIdIsNotGiven or InvalidTimeInterval or TaskNotExistsOrNotAssignedToNode or TimeIntervalIsTooLong or BothDatesMustBeSetToNullOrToValue or CorrectionDoesNotExist or InvalidCorrectionType</Error>
        </ManualWorkitemErrorWithIndex>
        <ManualWorkitemErrorWithIndex>
          <Index>int</Index>
          <Error>SubscriptionExpired or SpecificTaskIdIsInvalid or AccessDenied or UnknownError or OK or TimeIntervalIsOutdated or NodeDoesNotExist or CorrectionTypeIsNotValid or TaskIdIsNotGiven or InvalidTimeInterval or TaskNotExistsOrNotAssignedToNode or TimeIntervalIsTooLong or BothDatesMustBeSetToNullOrToValue or CorrectionDoesNotExist or InvalidCorrectionType</Error>
        </ManualWorkitemErrorWithIndex>
      </errorsByRowIndex>
    </AddManualWorkitemsResponse>
  </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>
    <AddManualWorkitems xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <manualWorkItems>
        <APIManualWorkItem>
          <Id>int</Id>
          <ManualWorkItemType>ReplaceInterval or AddWork or DeleteInterval</ManualWorkItemType>
          <WorkId>int</WorkId>
          <SpecificTaskId>int</SpecificTaskId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <UserId>int</UserId>
          <CompanyId>int</CompanyId>
          <Comment>string</Comment>
          <CreateDate>dateTime</CreateDate>
          <CreatedBy>int</CreatedBy>
          <TaskName>string</TaskName>
          <TaskNameWithCompletePath>string</TaskNameWithCompletePath>
          <SpecificTaskNameWithCompletePath>string</SpecificTaskNameWithCompletePath>
          <RequestStatus>Requested or Approved or Rejected or Revoked or Deleted</RequestStatus>
        </APIManualWorkItem>
        <APIManualWorkItem>
          <Id>int</Id>
          <ManualWorkItemType>ReplaceInterval or AddWork or DeleteInterval</ManualWorkItemType>
          <WorkId>int</WorkId>
          <SpecificTaskId>int</SpecificTaskId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <UserId>int</UserId>
          <CompanyId>int</CompanyId>
          <Comment>string</Comment>
          <CreateDate>dateTime</CreateDate>
          <CreatedBy>int</CreatedBy>
          <TaskName>string</TaskName>
          <TaskNameWithCompletePath>string</TaskNameWithCompletePath>
          <SpecificTaskNameWithCompletePath>string</SpecificTaskNameWithCompletePath>
          <RequestStatus>Requested or Approved or Rejected or Revoked or Deleted</RequestStatus>
        </APIManualWorkItem>
      </manualWorkItems>
    </AddManualWorkitems>
  </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>
    <AddManualWorkitemsResponse xmlns="http://jobctrl.com/">
      <AddManualWorkitemsResult>OK or UnknownError or AuthCodeInvalid</AddManualWorkitemsResult>
      <errorsByRowIndex>
        <ManualWorkitemErrorWithIndex>
          <Index>int</Index>
          <Error>SubscriptionExpired or SpecificTaskIdIsInvalid or AccessDenied or UnknownError or OK or TimeIntervalIsOutdated or NodeDoesNotExist or CorrectionTypeIsNotValid or TaskIdIsNotGiven or InvalidTimeInterval or TaskNotExistsOrNotAssignedToNode or TimeIntervalIsTooLong or BothDatesMustBeSetToNullOrToValue or CorrectionDoesNotExist or InvalidCorrectionType</Error>
        </ManualWorkitemErrorWithIndex>
        <ManualWorkitemErrorWithIndex>
          <Index>int</Index>
          <Error>SubscriptionExpired or SpecificTaskIdIsInvalid or AccessDenied or UnknownError or OK or TimeIntervalIsOutdated or NodeDoesNotExist or CorrectionTypeIsNotValid or TaskIdIsNotGiven or InvalidTimeInterval or TaskNotExistsOrNotAssignedToNode or TimeIntervalIsTooLong or BothDatesMustBeSetToNullOrToValue or CorrectionDoesNotExist or InvalidCorrectionType</Error>
        </ManualWorkitemErrorWithIndex>
      </errorsByRowIndex>
    </AddManualWorkitemsResponse>
  </soap12:Body>
</soap12:Envelope>