WHOSOFF API

Overview

WhosOff® is owned and operated by X:drive Computing Limited.

This outlines the Remote API provided WhosOff®. Primarily this API has been developed for integration with account holders’ internal systems.

The API is READ ONLY.

Required Authorisation

The API is not accessable within the trial account.

To gain access to the API, a super user of the account must request access via email and supply external IP addresses within the mail.

Security

The service is locked down by IP address(es) and supplied server key.

WhosOff® will require the IP address from the account holder of the requesting computer and WhosOff® will supply a unique ‘Server Key’ to allow the account holder access to the API.

System Key

Each of the procedures requires a system key (which is case sensitive) supplied by WhosOff®; this is added to provide another level of security. WhosOff® reserves the right to change system key or remove access at any time without prior notice.

Usage

Use of this API and associated data is at your own risk and responsibility, please be aware that we do not implement any of the data rules applied by the online system eg ‘cross dept viewing’ and other leave associated restrictions. If required, you will need to implement this in your own application. At the present time the API only returns read-only data.

Fair Use Policy

From time to time we will monitor your usage of the service, and where necessary we may implement restrictions without notice.

Request Information

Header Content

Header content should include 'Auth-Key' with the key supplied by the WhosOff

Endpoints

Your endpoint will be advised by email.

Version 1

Endpoint Description
GET /api/staff Retrieve staff details including tags and allowances
GET /api/department Retrieve department names
GET /api/tag Retrieve tag names
GET /api/free-restricted Retrieve free / restricted details
GET /api/leave-type Retrieve leave type names
GET /api/V2/whosoff Retrieve leave details

Version 3

Endpoint Description
GET /api/v3/staff Retrieve staff details including tags and allowances
GET /api/v3/department Retrieve department names
GET /api/v3/tag Retrieve tag names
GET /api/v3/leave-type Retrieve leave type names
GET /api/V3/whosoff Retrieve leave details

General Response Information

Status Status Code Description
OK 200 Request accepted and data returned via json
Bad request 400 Request rejected return error message via json
Page not found 404 Endpoint not valid

Standard Acceptance Example - Status Code 200

application/json
{
  "Data": [
    {     
      "Name": "Directors"
    },
    {
      "Name": "IT"
    },
    {
      "Name": "Sales"
    }
  ]
}

Standard Error Example - Status Code 400

application/json
{
  "Error_Message": "Date range can only be for a maximum of 365 days"
}


INSTANTLY REDUCE TIME SPENT ON LEAVE MANAGEMENT

Get your long FREE trial today!

No obligation and no payment setup required.
Sign up today and get until Wednesday, 25 November to try the full service, for Free!
 

Start Your Free Trial

Close menu Home Features Tour Pricing Free Trial Support Contact us Our blog Sign in