API Web Service

API

Click here for a complete list of operations.

GetWorktimeSchedulesOfUsers

Gets schedules of users

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

<?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>
    <GetWorktimeSchedulesOfUsers xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <targetUserIds>
        <int>int</int>
        <int>int</int>
      </targetUserIds>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
    </GetWorktimeSchedulesOfUsers>
  </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>
    <GetWorktimeSchedulesOfUsersResponse xmlns="http://jobctrl.com/">
      <GetWorktimeSchedulesOfUsersResult>OK or UnknownError or AuthCodeNotValid</GetWorktimeSchedulesOfUsersResult>
      <worktimeSchedules>
        <WorktimeSchedule>
          <Id>int</Id>
          <UserId>int</UserId>
          <LocalDay>dateTime</LocalDay>
          <Items>
            <WorktimeScheduleItem xsi:nil="true" />
            <WorktimeScheduleItem xsi:nil="true" />
          </Items>
          <IsInOffice>boolean</IsInOffice>
          <ExtendedProperties>
            <ExtendedProperty xsi:nil="true" />
            <ExtendedProperty xsi:nil="true" />
          </ExtendedProperties>
        </WorktimeSchedule>
        <WorktimeSchedule>
          <Id>int</Id>
          <UserId>int</UserId>
          <LocalDay>dateTime</LocalDay>
          <Items>
            <WorktimeScheduleItem xsi:nil="true" />
            <WorktimeScheduleItem xsi:nil="true" />
          </Items>
          <IsInOffice>boolean</IsInOffice>
          <ExtendedProperties>
            <ExtendedProperty xsi:nil="true" />
            <ExtendedProperty xsi:nil="true" />
          </ExtendedProperties>
        </WorktimeSchedule>
      </worktimeSchedules>
    </GetWorktimeSchedulesOfUsersResponse>
  </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>
    <GetWorktimeSchedulesOfUsers xmlns="http://jobctrl.com/">
      <companyAuthCode>guid</companyAuthCode>
      <targetUserIds>
        <int>int</int>
        <int>int</int>
      </targetUserIds>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
    </GetWorktimeSchedulesOfUsers>
  </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>
    <GetWorktimeSchedulesOfUsersResponse xmlns="http://jobctrl.com/">
      <GetWorktimeSchedulesOfUsersResult>OK or UnknownError or AuthCodeNotValid</GetWorktimeSchedulesOfUsersResult>
      <worktimeSchedules>
        <WorktimeSchedule>
          <Id>int</Id>
          <UserId>int</UserId>
          <LocalDay>dateTime</LocalDay>
          <Items>
            <WorktimeScheduleItem xsi:nil="true" />
            <WorktimeScheduleItem xsi:nil="true" />
          </Items>
          <IsInOffice>boolean</IsInOffice>
          <ExtendedProperties>
            <ExtendedProperty xsi:nil="true" />
            <ExtendedProperty xsi:nil="true" />
          </ExtendedProperties>
        </WorktimeSchedule>
        <WorktimeSchedule>
          <Id>int</Id>
          <UserId>int</UserId>
          <LocalDay>dateTime</LocalDay>
          <Items>
            <WorktimeScheduleItem xsi:nil="true" />
            <WorktimeScheduleItem xsi:nil="true" />
          </Items>
          <IsInOffice>boolean</IsInOffice>
          <ExtendedProperties>
            <ExtendedProperty xsi:nil="true" />
            <ExtendedProperty xsi:nil="true" />
          </ExtendedProperties>
        </WorktimeSchedule>
      </worktimeSchedules>
    </GetWorktimeSchedulesOfUsersResponse>
  </soap12:Body>
</soap12:Envelope>