API Web Service

API

Click here for a complete list of operations.

GetWorktimeReport

Get the company's work time report for the specified time interval

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

<?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>
    <GetWorktimeReport xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <startDay>dateTime</startDay>
      <endDay>dateTime</endDay>
      <userIdList>
        <int>int</int>
        <int>int</int>
      </userIdList>
      <workerGroupIds>
        <int>int</int>
        <int>int</int>
      </workerGroupIds>
    </GetWorktimeReport>
  </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>
    <GetWorktimeReportResponse xmlns="http://jobctrl.com/">
      <GetWorktimeReportResult>OK or UnknownError or AuthCodeNotValid</GetWorktimeReportResult>
      <Report>
        <ReportColumns>
          <ReportColumn>
            <Id>int</Id>
            <Interval xsi:nil="true" />
            <Type>WorkerGroupName or WorkerName or ProjectName or TaskName or Date or Time or Description or ProcessName or WindowSize or SingleDay or Summary or Average or WindowIsActive or RawText</Type>
            <ColumnName>string</ColumnName>
          </ReportColumn>
          <ReportColumn>
            <Id>int</Id>
            <Interval xsi:nil="true" />
            <Type>WorkerGroupName or WorkerName or ProjectName or TaskName or Date or Time or Description or ProcessName or WindowSize or SingleDay or Summary or Average or WindowIsActive or RawText</Type>
            <ColumnName>string</ColumnName>
          </ReportColumn>
        </ReportColumns>
        <WorktimeReportDataList>
          <WorktimeReportData>
            <UserId>int</UserId>
            <ReportColumn xsi:nil="true" />
            <TotalWorkTimeNetMs>long</TotalWorkTimeNetMs>
            <SumSpecialTaskWorkTimes xsi:nil="true" />
            <ComputerWorkTimeNetMs>long</ComputerWorkTimeNetMs>
            <ActiveComputerWorkTimeMs>long</ActiveComputerWorkTimeMs>
            <IdleComputerWorkTimeMs>long</IdleComputerWorkTimeMs>
            <OfficeWorkTimeMs>long</OfficeWorkTimeMs>
            <OutOfOfficeWorkTimeMs>long</OutOfOfficeWorkTimeMs>
            <MobileWorkTimeNetMs>long</MobileWorkTimeNetMs>
            <MobileCallWorkTimeNetMs>long</MobileCallWorkTimeNetMs>
            <ManualWorkTimeNetMs>long</ManualWorkTimeNetMs>
            <HolidayTimeMs>long</HolidayTimeMs>
            <SickLeaveTimeMs>long</SickLeaveTimeMs>
            <AdhocMeetingTimeMs>long</AdhocMeetingTimeMs>
            <CalendarMeetingTimeMs>long</CalendarMeetingTimeMs>
            <StartOfWorkMs>long</StartOfWorkMs>
            <EndOfWorkMs>long</EndOfWorkMs>
            <LateStartOfWorkSingleDay xsi:nil="true" />
            <EarlyEndOfWorkSingleDay xsi:nil="true" />
            <ViolateCoreTimeSingleDay xsi:nil="true" />
            <LateStartOfWorkSummary>int</LateStartOfWorkSummary>
            <EarlyEndOfWorkSummary>int</EarlyEndOfWorkSummary>
            <ViolateCoreTimeSummary>int</ViolateCoreTimeSummary>
            <WorkTimeFrameDifferenceMs>long</WorkTimeFrameDifferenceMs>
            <NumberOfIncidents>int</NumberOfIncidents>
            <TimeSpentAtWorkplaceMs>long</TimeSpentAtWorkplaceMs>
            <IneffectiveWorkTimeMs>long</IneffectiveWorkTimeMs>
            <NumberOfActiveWorkdays>int</NumberOfActiveWorkdays>
            <NumberOfOfficialWorkdays>int</NumberOfOfficialWorkdays>
          </WorktimeReportData>
          <WorktimeReportData>
            <UserId>int</UserId>
            <ReportColumn xsi:nil="true" />
            <TotalWorkTimeNetMs>long</TotalWorkTimeNetMs>
            <SumSpecialTaskWorkTimes xsi:nil="true" />
            <ComputerWorkTimeNetMs>long</ComputerWorkTimeNetMs>
            <ActiveComputerWorkTimeMs>long</ActiveComputerWorkTimeMs>
            <IdleComputerWorkTimeMs>long</IdleComputerWorkTimeMs>
            <OfficeWorkTimeMs>long</OfficeWorkTimeMs>
            <OutOfOfficeWorkTimeMs>long</OutOfOfficeWorkTimeMs>
            <MobileWorkTimeNetMs>long</MobileWorkTimeNetMs>
            <MobileCallWorkTimeNetMs>long</MobileCallWorkTimeNetMs>
            <ManualWorkTimeNetMs>long</ManualWorkTimeNetMs>
            <HolidayTimeMs>long</HolidayTimeMs>
            <SickLeaveTimeMs>long</SickLeaveTimeMs>
            <AdhocMeetingTimeMs>long</AdhocMeetingTimeMs>
            <CalendarMeetingTimeMs>long</CalendarMeetingTimeMs>
            <StartOfWorkMs>long</StartOfWorkMs>
            <EndOfWorkMs>long</EndOfWorkMs>
            <LateStartOfWorkSingleDay xsi:nil="true" />
            <EarlyEndOfWorkSingleDay xsi:nil="true" />
            <ViolateCoreTimeSingleDay xsi:nil="true" />
            <LateStartOfWorkSummary>int</LateStartOfWorkSummary>
            <EarlyEndOfWorkSummary>int</EarlyEndOfWorkSummary>
            <ViolateCoreTimeSummary>int</ViolateCoreTimeSummary>
            <WorkTimeFrameDifferenceMs>long</WorkTimeFrameDifferenceMs>
            <NumberOfIncidents>int</NumberOfIncidents>
            <TimeSpentAtWorkplaceMs>long</TimeSpentAtWorkplaceMs>
            <IneffectiveWorkTimeMs>long</IneffectiveWorkTimeMs>
            <NumberOfActiveWorkdays>int</NumberOfActiveWorkdays>
            <NumberOfOfficialWorkdays>int</NumberOfOfficialWorkdays>
          </WorktimeReportData>
        </WorktimeReportDataList>
      </Report>
    </GetWorktimeReportResponse>
  </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>
    <GetWorktimeReport xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <startDay>dateTime</startDay>
      <endDay>dateTime</endDay>
      <userIdList>
        <int>int</int>
        <int>int</int>
      </userIdList>
      <workerGroupIds>
        <int>int</int>
        <int>int</int>
      </workerGroupIds>
    </GetWorktimeReport>
  </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>
    <GetWorktimeReportResponse xmlns="http://jobctrl.com/">
      <GetWorktimeReportResult>OK or UnknownError or AuthCodeNotValid</GetWorktimeReportResult>
      <Report>
        <ReportColumns>
          <ReportColumn>
            <Id>int</Id>
            <Interval xsi:nil="true" />
            <Type>WorkerGroupName or WorkerName or ProjectName or TaskName or Date or Time or Description or ProcessName or WindowSize or SingleDay or Summary or Average or WindowIsActive or RawText</Type>
            <ColumnName>string</ColumnName>
          </ReportColumn>
          <ReportColumn>
            <Id>int</Id>
            <Interval xsi:nil="true" />
            <Type>WorkerGroupName or WorkerName or ProjectName or TaskName or Date or Time or Description or ProcessName or WindowSize or SingleDay or Summary or Average or WindowIsActive or RawText</Type>
            <ColumnName>string</ColumnName>
          </ReportColumn>
        </ReportColumns>
        <WorktimeReportDataList>
          <WorktimeReportData>
            <UserId>int</UserId>
            <ReportColumn xsi:nil="true" />
            <TotalWorkTimeNetMs>long</TotalWorkTimeNetMs>
            <SumSpecialTaskWorkTimes xsi:nil="true" />
            <ComputerWorkTimeNetMs>long</ComputerWorkTimeNetMs>
            <ActiveComputerWorkTimeMs>long</ActiveComputerWorkTimeMs>
            <IdleComputerWorkTimeMs>long</IdleComputerWorkTimeMs>
            <OfficeWorkTimeMs>long</OfficeWorkTimeMs>
            <OutOfOfficeWorkTimeMs>long</OutOfOfficeWorkTimeMs>
            <MobileWorkTimeNetMs>long</MobileWorkTimeNetMs>
            <MobileCallWorkTimeNetMs>long</MobileCallWorkTimeNetMs>
            <ManualWorkTimeNetMs>long</ManualWorkTimeNetMs>
            <HolidayTimeMs>long</HolidayTimeMs>
            <SickLeaveTimeMs>long</SickLeaveTimeMs>
            <AdhocMeetingTimeMs>long</AdhocMeetingTimeMs>
            <CalendarMeetingTimeMs>long</CalendarMeetingTimeMs>
            <StartOfWorkMs>long</StartOfWorkMs>
            <EndOfWorkMs>long</EndOfWorkMs>
            <LateStartOfWorkSingleDay xsi:nil="true" />
            <EarlyEndOfWorkSingleDay xsi:nil="true" />
            <ViolateCoreTimeSingleDay xsi:nil="true" />
            <LateStartOfWorkSummary>int</LateStartOfWorkSummary>
            <EarlyEndOfWorkSummary>int</EarlyEndOfWorkSummary>
            <ViolateCoreTimeSummary>int</ViolateCoreTimeSummary>
            <WorkTimeFrameDifferenceMs>long</WorkTimeFrameDifferenceMs>
            <NumberOfIncidents>int</NumberOfIncidents>
            <TimeSpentAtWorkplaceMs>long</TimeSpentAtWorkplaceMs>
            <IneffectiveWorkTimeMs>long</IneffectiveWorkTimeMs>
            <NumberOfActiveWorkdays>int</NumberOfActiveWorkdays>
            <NumberOfOfficialWorkdays>int</NumberOfOfficialWorkdays>
          </WorktimeReportData>
          <WorktimeReportData>
            <UserId>int</UserId>
            <ReportColumn xsi:nil="true" />
            <TotalWorkTimeNetMs>long</TotalWorkTimeNetMs>
            <SumSpecialTaskWorkTimes xsi:nil="true" />
            <ComputerWorkTimeNetMs>long</ComputerWorkTimeNetMs>
            <ActiveComputerWorkTimeMs>long</ActiveComputerWorkTimeMs>
            <IdleComputerWorkTimeMs>long</IdleComputerWorkTimeMs>
            <OfficeWorkTimeMs>long</OfficeWorkTimeMs>
            <OutOfOfficeWorkTimeMs>long</OutOfOfficeWorkTimeMs>
            <MobileWorkTimeNetMs>long</MobileWorkTimeNetMs>
            <MobileCallWorkTimeNetMs>long</MobileCallWorkTimeNetMs>
            <ManualWorkTimeNetMs>long</ManualWorkTimeNetMs>
            <HolidayTimeMs>long</HolidayTimeMs>
            <SickLeaveTimeMs>long</SickLeaveTimeMs>
            <AdhocMeetingTimeMs>long</AdhocMeetingTimeMs>
            <CalendarMeetingTimeMs>long</CalendarMeetingTimeMs>
            <StartOfWorkMs>long</StartOfWorkMs>
            <EndOfWorkMs>long</EndOfWorkMs>
            <LateStartOfWorkSingleDay xsi:nil="true" />
            <EarlyEndOfWorkSingleDay xsi:nil="true" />
            <ViolateCoreTimeSingleDay xsi:nil="true" />
            <LateStartOfWorkSummary>int</LateStartOfWorkSummary>
            <EarlyEndOfWorkSummary>int</EarlyEndOfWorkSummary>
            <ViolateCoreTimeSummary>int</ViolateCoreTimeSummary>
            <WorkTimeFrameDifferenceMs>long</WorkTimeFrameDifferenceMs>
            <NumberOfIncidents>int</NumberOfIncidents>
            <TimeSpentAtWorkplaceMs>long</TimeSpentAtWorkplaceMs>
            <IneffectiveWorkTimeMs>long</IneffectiveWorkTimeMs>
            <NumberOfActiveWorkdays>int</NumberOfActiveWorkdays>
            <NumberOfOfficialWorkdays>int</NumberOfOfficialWorkdays>
          </WorktimeReportData>
        </WorktimeReportDataList>
      </Report>
    </GetWorktimeReportResponse>
  </soap12:Body>
</soap12:Envelope>