API Web Service

API

Click here for a complete list of operations.

AddManualWorkitem

Adds a manual workitem

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

<?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>
    <AddManualWorkitem xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <targetUserId>int</targetUserId>
      <startDateInUtc>dateTime</startDateInUtc>
      <endDateInUtc>dateTime</endDateInUtc>
      <taskId>int</taskId>
      <comment>string</comment>
    </AddManualWorkitem>
  </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>
    <AddManualWorkitemResponse xmlns="http://jobctrl.com/">
      <AddManualWorkitemResult>OK or UnknownError or AuthCodeInvalid or SubscriptionExpired or AccessDenied or TimeIntervalIsOutdated or CorrectionTypeIsNotValid or TaskIdIsNotGiven or InvalidTimeInterval or TaskNotExistsOrNotAssignedToUser or TimeIntervalIsTooLong or BothDatesMustBeSetToNullOrToValue</AddManualWorkitemResult>
    </AddManualWorkitemResponse>
  </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>
    <AddManualWorkitem xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <targetUserId>int</targetUserId>
      <startDateInUtc>dateTime</startDateInUtc>
      <endDateInUtc>dateTime</endDateInUtc>
      <taskId>int</taskId>
      <comment>string</comment>
    </AddManualWorkitem>
  </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>
    <AddManualWorkitemResponse xmlns="http://jobctrl.com/">
      <AddManualWorkitemResult>OK or UnknownError or AuthCodeInvalid or SubscriptionExpired or AccessDenied or TimeIntervalIsOutdated or CorrectionTypeIsNotValid or TaskIdIsNotGiven or InvalidTimeInterval or TaskNotExistsOrNotAssignedToUser or TimeIntervalIsTooLong or BothDatesMustBeSetToNullOrToValue</AddManualWorkitemResult>
    </AddManualWorkitemResponse>
  </soap12:Body>
</soap12:Envelope>