API Web Service

API

Click here for a complete list of operations.

CreateWorktimeSchedule

Creates a worktime schedule for a user

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

<?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>
    <CreateWorktimeSchedule xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <worktimeSchedule>
        <Id>int</Id>
        <UserId>int</UserId>
        <LocalDay>dateTime</LocalDay>
        <Items>
          <WorktimeScheduleItem>
            <Id>int</Id>
            <WorktimeScheduleId>int</WorktimeScheduleId>
            <UtcStartDate>dateTime</UtcStartDate>
            <UtcEndDate>dateTime</UtcEndDate>
            <TaskId>int</TaskId>
            <IsOvertime>boolean</IsOvertime>
            <ExtendedProperties xsi:nil="true" />
          </WorktimeScheduleItem>
          <WorktimeScheduleItem>
            <Id>int</Id>
            <WorktimeScheduleId>int</WorktimeScheduleId>
            <UtcStartDate>dateTime</UtcStartDate>
            <UtcEndDate>dateTime</UtcEndDate>
            <TaskId>int</TaskId>
            <IsOvertime>boolean</IsOvertime>
            <ExtendedProperties xsi:nil="true" />
          </WorktimeScheduleItem>
        </Items>
        <IsInOffice>boolean</IsInOffice>
        <ExtendedProperties>
          <ExtendedProperty>
            <Name>string</Name>
            <Value>string</Value>
          </ExtendedProperty>
          <ExtendedProperty>
            <Name>string</Name>
            <Value>string</Value>
          </ExtendedProperty>
        </ExtendedProperties>
      </worktimeSchedule>
    </CreateWorktimeSchedule>
  </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>
    <CreateWorktimeScheduleResponse xmlns="http://jobctrl.com/">
      <CreateWorktimeScheduleResult>OK or UnknownError or AuthCodeNotValid or AccessDenied or ScheduleIsEmpty or ItemIsTooLong or NegativeItemInterval or InvalidTaskId or ItemIsOutOfIntervalRange or OverlappingItemIntervals or ExtendedPropertyNameCannotBeEmpty or ExtendedPropertyNameIsNotUnique or OverlappingItemIntervalAlreadyExist or IsWorkDayAndIsInOfficeConflict</CreateWorktimeScheduleResult>
      <createdId>int</createdId>
    </CreateWorktimeScheduleResponse>
  </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>
    <CreateWorktimeSchedule xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <worktimeSchedule>
        <Id>int</Id>
        <UserId>int</UserId>
        <LocalDay>dateTime</LocalDay>
        <Items>
          <WorktimeScheduleItem>
            <Id>int</Id>
            <WorktimeScheduleId>int</WorktimeScheduleId>
            <UtcStartDate>dateTime</UtcStartDate>
            <UtcEndDate>dateTime</UtcEndDate>
            <TaskId>int</TaskId>
            <IsOvertime>boolean</IsOvertime>
            <ExtendedProperties xsi:nil="true" />
          </WorktimeScheduleItem>
          <WorktimeScheduleItem>
            <Id>int</Id>
            <WorktimeScheduleId>int</WorktimeScheduleId>
            <UtcStartDate>dateTime</UtcStartDate>
            <UtcEndDate>dateTime</UtcEndDate>
            <TaskId>int</TaskId>
            <IsOvertime>boolean</IsOvertime>
            <ExtendedProperties xsi:nil="true" />
          </WorktimeScheduleItem>
        </Items>
        <IsInOffice>boolean</IsInOffice>
        <ExtendedProperties>
          <ExtendedProperty>
            <Name>string</Name>
            <Value>string</Value>
          </ExtendedProperty>
          <ExtendedProperty>
            <Name>string</Name>
            <Value>string</Value>
          </ExtendedProperty>
        </ExtendedProperties>
      </worktimeSchedule>
    </CreateWorktimeSchedule>
  </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>
    <CreateWorktimeScheduleResponse xmlns="http://jobctrl.com/">
      <CreateWorktimeScheduleResult>OK or UnknownError or AuthCodeNotValid or AccessDenied or ScheduleIsEmpty or ItemIsTooLong or NegativeItemInterval or InvalidTaskId or ItemIsOutOfIntervalRange or OverlappingItemIntervals or ExtendedPropertyNameCannotBeEmpty or ExtendedPropertyNameIsNotUnique or OverlappingItemIntervalAlreadyExist or IsWorkDayAndIsInOfficeConflict</CreateWorktimeScheduleResult>
      <createdId>int</createdId>
    </CreateWorktimeScheduleResponse>
  </soap12:Body>
</soap12:Envelope>