API Web Service

API

Click here for a complete list of operations.

AddHolidayForUser

Creates a holiday for a specific 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: kr.jobctrl.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://jobctrl.com/AddHolidayForUser"

<?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>
    <AddHolidayForUser xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <userId>int</userId>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <dailyDurationInMins>int</dailyDurationInMins>
      <holidayCategoryId>int</holidayCategoryId>
    </AddHolidayForUser>
  </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>
    <AddHolidayForUserResponse xmlns="http://jobctrl.com/">
      <AddHolidayForUserResult>OK or AccessDenied or UnknownError or AuthCodeNotValid or SubscriptionExpired or TimeIntervalIsOutdated or InvalidTimeInterval or IntervalIsNotEmpty or InvalidDailyDuration or InvalidHolidayCategory</AddHolidayForUserResult>
      <createdHolidayId>int</createdHolidayId>
    </AddHolidayForUserResponse>
  </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>
    <AddHolidayForUser xmlns="http://jobctrl.com/">
      <CompanyAuthCode>guid</CompanyAuthCode>
      <userId>int</userId>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <dailyDurationInMins>int</dailyDurationInMins>
      <holidayCategoryId>int</holidayCategoryId>
    </AddHolidayForUser>
  </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>
    <AddHolidayForUserResponse xmlns="http://jobctrl.com/">
      <AddHolidayForUserResult>OK or AccessDenied or UnknownError or AuthCodeNotValid or SubscriptionExpired or TimeIntervalIsOutdated or InvalidTimeInterval or IntervalIsNotEmpty or InvalidDailyDuration or InvalidHolidayCategory</AddHolidayForUserResult>
      <createdHolidayId>int</createdHolidayId>
    </AddHolidayForUserResponse>
  </soap12:Body>
</soap12:Envelope>