API Web Service

API

Click here for a complete list of operations.

CreateWorktimeSchedule_v2

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: jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/CreateWorktimeSchedule_v2"

<?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_v2 xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <worktimeSchedule>
        <Id>int</Id>
        <UserId>int</UserId>
        <LocalDay>dateTime</LocalDay>
        <Items>
          <WorktimeScheduleItem_v2>
            <Id>int</Id>
            <WorktimeScheduleId>int</WorktimeScheduleId>
            <UtcStartDate>dateTime</UtcStartDate>
            <UtcEndDate>dateTime</UtcEndDate>
            <TaskId>int</TaskId>
            <IsOvertime>boolean</IsOvertime>
            <CategoryId>int</CategoryId>
            <ExtendedProperties xsi:nil="true" />
          </WorktimeScheduleItem_v2>
          <WorktimeScheduleItem_v2>
            <Id>int</Id>
            <WorktimeScheduleId>int</WorktimeScheduleId>
            <UtcStartDate>dateTime</UtcStartDate>
            <UtcEndDate>dateTime</UtcEndDate>
            <TaskId>int</TaskId>
            <IsOvertime>boolean</IsOvertime>
            <CategoryId>int</CategoryId>
            <ExtendedProperties xsi:nil="true" />
          </WorktimeScheduleItem_v2>
        </Items>
        <IsWorkDay>boolean</IsWorkDay>
        <IsInOffice>boolean</IsInOffice>
        <ExtendedProperties>
          <ExtendedProperty>
            <Name>string</Name>
            <Value>string</Value>
          </ExtendedProperty>
          <ExtendedProperty>
            <Name>string</Name>
            <Value>string</Value>
          </ExtendedProperty>
        </ExtendedProperties>
        <IsApproved>boolean</IsApproved>
      </worktimeSchedule>
    </CreateWorktimeSchedule_v2>
  </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>
    <CreateWorktimeSchedule_v2Response xmlns="http://jobctrl.com/">
      <CreateWorktimeSchedule_v2Result>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 or ItemsShouldBeEmptyOnNonWorkdays or CannotRequestInTheFuture or ScheduleAlreadyExistsForTheGivenDay or InvalidCategoryId</CreateWorktimeSchedule_v2Result>
      <createdId>int</createdId>
    </CreateWorktimeSchedule_v2Response>
  </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>
    <CreateWorktimeSchedule_v2 xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <worktimeSchedule>
        <Id>int</Id>
        <UserId>int</UserId>
        <LocalDay>dateTime</LocalDay>
        <Items>
          <WorktimeScheduleItem_v2>
            <Id>int</Id>
            <WorktimeScheduleId>int</WorktimeScheduleId>
            <UtcStartDate>dateTime</UtcStartDate>
            <UtcEndDate>dateTime</UtcEndDate>
            <TaskId>int</TaskId>
            <IsOvertime>boolean</IsOvertime>
            <CategoryId>int</CategoryId>
            <ExtendedProperties xsi:nil="true" />
          </WorktimeScheduleItem_v2>
          <WorktimeScheduleItem_v2>
            <Id>int</Id>
            <WorktimeScheduleId>int</WorktimeScheduleId>
            <UtcStartDate>dateTime</UtcStartDate>
            <UtcEndDate>dateTime</UtcEndDate>
            <TaskId>int</TaskId>
            <IsOvertime>boolean</IsOvertime>
            <CategoryId>int</CategoryId>
            <ExtendedProperties xsi:nil="true" />
          </WorktimeScheduleItem_v2>
        </Items>
        <IsWorkDay>boolean</IsWorkDay>
        <IsInOffice>boolean</IsInOffice>
        <ExtendedProperties>
          <ExtendedProperty>
            <Name>string</Name>
            <Value>string</Value>
          </ExtendedProperty>
          <ExtendedProperty>
            <Name>string</Name>
            <Value>string</Value>
          </ExtendedProperty>
        </ExtendedProperties>
        <IsApproved>boolean</IsApproved>
      </worktimeSchedule>
    </CreateWorktimeSchedule_v2>
  </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>
    <CreateWorktimeSchedule_v2Response xmlns="http://jobctrl.com/">
      <CreateWorktimeSchedule_v2Result>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 or ItemsShouldBeEmptyOnNonWorkdays or CannotRequestInTheFuture or ScheduleAlreadyExistsForTheGivenDay or InvalidCategoryId</CreateWorktimeSchedule_v2Result>
      <createdId>int</createdId>
    </CreateWorktimeSchedule_v2Response>
  </soap12:Body>
</soap12:Envelope>