API Web Service

API

Click here for a complete list of operations.

GetApprovableHolidayRequests

Gets the approvable holiday requests for specific users or for the whole company.

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

<?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>
    <GetApprovableHolidayRequests xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <UserIds>
        <int>int</int>
        <int>int</int>
      </UserIds>
    </GetApprovableHolidayRequests>
  </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>
    <GetApprovableHolidayRequestsResponse xmlns="http://jobctrl.com/">
      <GetApprovableHolidayRequestsResult>OK or UnknownError or AuthCodeNotValid</GetApprovableHolidayRequestsResult>
      <holidays>
        <Holiday>
          <Id>int</Id>
          <UserId>int</UserId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <DailyDurationInMins>int</DailyDurationInMins>
          <NumberOfWorkDays>int</NumberOfWorkDays>
          <HolidayCategoryId>int</HolidayCategoryId>
          <ApprovedBy>int</ApprovedBy>
          <IsWholeDay>boolean</IsWholeDay>
        </Holiday>
        <Holiday>
          <Id>int</Id>
          <UserId>int</UserId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <DailyDurationInMins>int</DailyDurationInMins>
          <NumberOfWorkDays>int</NumberOfWorkDays>
          <HolidayCategoryId>int</HolidayCategoryId>
          <ApprovedBy>int</ApprovedBy>
          <IsWholeDay>boolean</IsWholeDay>
        </Holiday>
      </holidays>
    </GetApprovableHolidayRequestsResponse>
  </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>
    <GetApprovableHolidayRequests xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <UserIds>
        <int>int</int>
        <int>int</int>
      </UserIds>
    </GetApprovableHolidayRequests>
  </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>
    <GetApprovableHolidayRequestsResponse xmlns="http://jobctrl.com/">
      <GetApprovableHolidayRequestsResult>OK or UnknownError or AuthCodeNotValid</GetApprovableHolidayRequestsResult>
      <holidays>
        <Holiday>
          <Id>int</Id>
          <UserId>int</UserId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <DailyDurationInMins>int</DailyDurationInMins>
          <NumberOfWorkDays>int</NumberOfWorkDays>
          <HolidayCategoryId>int</HolidayCategoryId>
          <ApprovedBy>int</ApprovedBy>
          <IsWholeDay>boolean</IsWholeDay>
        </Holiday>
        <Holiday>
          <Id>int</Id>
          <UserId>int</UserId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <DailyDurationInMins>int</DailyDurationInMins>
          <NumberOfWorkDays>int</NumberOfWorkDays>
          <HolidayCategoryId>int</HolidayCategoryId>
          <ApprovedBy>int</ApprovedBy>
          <IsWholeDay>boolean</IsWholeDay>
        </Holiday>
      </holidays>
    </GetApprovableHolidayRequestsResponse>
  </soap12:Body>
</soap12:Envelope>