API Web Service

API

Click here for a complete list of operations.

GetCalendarExceptionsOfCalendar

Returns the a calendar exceptions directly assigned to a specific calendar

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

<?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>
    <GetCalendarExceptionsOfCalendar xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <CalendarId>int</CalendarId>
      <StartDay>dateTime</StartDay>
      <EndDay>dateTime</EndDay>
    </GetCalendarExceptionsOfCalendar>
  </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>
    <GetCalendarExceptionsOfCalendarResponse xmlns="http://jobctrl.com/">
      <GetCalendarExceptionsOfCalendarResult>OK or UnknownError or AuthCodeNotValid or AccessDenied</GetCalendarExceptionsOfCalendarResult>
      <CalendarExceptions>
        <CalendarException>
          <Id>int</Id>
          <Day>dateTime</Day>
          <Name>string</Name>
          <WorktimeSetting>
            <StartTimeInMinutes>short</StartTimeInMinutes>
            <EndTimeInMinutes>short</EndTimeInMinutes>
            <MinimumWorkTimeInMinutes>short</MinimumWorkTimeInMinutes>
            <DailyWorkTimeInMinutes>short</DailyWorkTimeInMinutes>
            <IsWorkDay>boolean</IsWorkDay>
            <ExtraWorktimeBeforeCoreTimeStartInMinutes>short</ExtraWorktimeBeforeCoreTimeStartInMinutes>
            <ExtraWorktimeAfterCoreTimeEndInMinutes>short</ExtraWorktimeAfterCoreTimeEndInMinutes>
            <StartOffsetInMinutes>short</StartOffsetInMinutes>
            <EndOffsetInMinutes>short</EndOffsetInMinutes>
          </WorktimeSetting>
        </CalendarException>
        <CalendarException>
          <Id>int</Id>
          <Day>dateTime</Day>
          <Name>string</Name>
          <WorktimeSetting>
            <StartTimeInMinutes>short</StartTimeInMinutes>
            <EndTimeInMinutes>short</EndTimeInMinutes>
            <MinimumWorkTimeInMinutes>short</MinimumWorkTimeInMinutes>
            <DailyWorkTimeInMinutes>short</DailyWorkTimeInMinutes>
            <IsWorkDay>boolean</IsWorkDay>
            <ExtraWorktimeBeforeCoreTimeStartInMinutes>short</ExtraWorktimeBeforeCoreTimeStartInMinutes>
            <ExtraWorktimeAfterCoreTimeEndInMinutes>short</ExtraWorktimeAfterCoreTimeEndInMinutes>
            <StartOffsetInMinutes>short</StartOffsetInMinutes>
            <EndOffsetInMinutes>short</EndOffsetInMinutes>
          </WorktimeSetting>
        </CalendarException>
      </CalendarExceptions>
    </GetCalendarExceptionsOfCalendarResponse>
  </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>
    <GetCalendarExceptionsOfCalendar xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <CalendarId>int</CalendarId>
      <StartDay>dateTime</StartDay>
      <EndDay>dateTime</EndDay>
    </GetCalendarExceptionsOfCalendar>
  </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>
    <GetCalendarExceptionsOfCalendarResponse xmlns="http://jobctrl.com/">
      <GetCalendarExceptionsOfCalendarResult>OK or UnknownError or AuthCodeNotValid or AccessDenied</GetCalendarExceptionsOfCalendarResult>
      <CalendarExceptions>
        <CalendarException>
          <Id>int</Id>
          <Day>dateTime</Day>
          <Name>string</Name>
          <WorktimeSetting>
            <StartTimeInMinutes>short</StartTimeInMinutes>
            <EndTimeInMinutes>short</EndTimeInMinutes>
            <MinimumWorkTimeInMinutes>short</MinimumWorkTimeInMinutes>
            <DailyWorkTimeInMinutes>short</DailyWorkTimeInMinutes>
            <IsWorkDay>boolean</IsWorkDay>
            <ExtraWorktimeBeforeCoreTimeStartInMinutes>short</ExtraWorktimeBeforeCoreTimeStartInMinutes>
            <ExtraWorktimeAfterCoreTimeEndInMinutes>short</ExtraWorktimeAfterCoreTimeEndInMinutes>
            <StartOffsetInMinutes>short</StartOffsetInMinutes>
            <EndOffsetInMinutes>short</EndOffsetInMinutes>
          </WorktimeSetting>
        </CalendarException>
        <CalendarException>
          <Id>int</Id>
          <Day>dateTime</Day>
          <Name>string</Name>
          <WorktimeSetting>
            <StartTimeInMinutes>short</StartTimeInMinutes>
            <EndTimeInMinutes>short</EndTimeInMinutes>
            <MinimumWorkTimeInMinutes>short</MinimumWorkTimeInMinutes>
            <DailyWorkTimeInMinutes>short</DailyWorkTimeInMinutes>
            <IsWorkDay>boolean</IsWorkDay>
            <ExtraWorktimeBeforeCoreTimeStartInMinutes>short</ExtraWorktimeBeforeCoreTimeStartInMinutes>
            <ExtraWorktimeAfterCoreTimeEndInMinutes>short</ExtraWorktimeAfterCoreTimeEndInMinutes>
            <StartOffsetInMinutes>short</StartOffsetInMinutes>
            <EndOffsetInMinutes>short</EndOffsetInMinutes>
          </WorktimeSetting>
        </CalendarException>
      </CalendarExceptions>
    </GetCalendarExceptionsOfCalendarResponse>
  </soap12:Body>
</soap12:Envelope>