API for Developers & Resellers

ASL allows Developers and Resellers to integrate any internal or external 3rd party applications with its software solutions. Developers can create complementary applications in virtually any language and business area and utilize data from the ASL HR Director data store. Our Application Programming Interface is a RESTful API that provides secure, authenticated, access to employees, users, organizational data, audit information and more.

Since data security is of primary importance, the Web Service is secured via SSL using HTTPS. In addition, access will only be allowed from known, and approved, customer and partner IP addresses to further secure and prevent unauthorized access to the HR data store.

The Web Service utilizes Javascript Object Notation – Web Services Protocol (JSON-WSP) for its ease of readability for software developers as well as lay people. It includes a number of methods to allow access to:

  • Security information
  • User-defined configuration data
  • Payroll & pay period data
  • Employee service & biographical data
  • Employee list
  • Benefits data

The structure of the API documentation is in a request and response format. Data elements referenced in any request or response will be mapped to specific tables and fields in the HR data store to aid in 3rd party software development.

Updates Method – Sample

The Updates method provides the user with an updated list of employees currently stored in HR Director. The requestor MUST supply valid credentials and 2 parameters – the company_id and version.

Request
Method  URL
GET  [companyname].aslconsulting.net/api/updates/<version>/company_id>/
 
Type Parameters Values
URL_PARAM <version> Number
URL_PARAM <company_id> Strong
 
Request
Status Response
200

Response will be an object containing the list of employees (array) & version #.

Each item in the employee array has the following structure.

[

    {

          "version": "version #",

          "employee_id": "36-char employee global unique id (GUID)",

          "employee_number": "10-char employee #",

          "name": "Lastname, Firstname",

          "sin": "9-digit SIN",

          "ssn": "9-digit SSN",

          "status": "[Active | Leave | Terminated]"

     }

]

Example Response:

[

    {

         "version":"1",

         "employee_id": "b1fb5e98-c341-432c-903c-6f70837c1f29",

         "employee_number": "0000001023",

         "name": "Davison, John",

         "sin": "999999998",

         "ssn": "",          "status": "Active"

   },

   {

          "version": "1",

         "employee_id": "2164ba51-4878-4a81-adaa-92514b348cd4",

         "employee_number": "0000002301",

          "name": "McNally, Ford",

         "sin": "",

         "ssn": "000000000",

         "status": "Active"

   } ]

 
400 {"error":"Please specify database version."}
400 {"error":"Invalid database version."}
500 {"error":"An unknown error has occurred. Please try again later."}
 

Request Technical Support