# Ascentis Client Library A node library for consuming Ascentis Web APIs. [![Build Status](https://travis-ci.org/PlayNetwork/node-ascentis.png?branch=develop)](https://travis-ci.org/PlayNetwork/node-ascentis) [![Coverage Status](https://coveralls.io/repos/PlayNetwork/node-ascentis/badge.png?branch=develop)](https://coveralls.io/r/PlayNetwork/node-ascentis?branch=develop) ## Features ## Install ```Bash npm install ascentis ``` ## Usage Ascentis Web API documentation: ```Javascript var ascentis = require('ascentis'); // initialize an API client var client = ascentis.initialize({ account : 'company', clientKey : 'clientKey', host : 'selfservice2.ascentis.com', secretKey : 'secretKey' }); // make API calls client.getEmployees(function (err, data) { if (!err) { // we haz teh datas } }); ``` ### Authentication Authentication is handled automatically for each API call provided that you supply the appropriate client key and secret key values. ### Find Employees ```Javascript client.getEmployees(function (err, data) { if (!err) { // we haz teh datas } }); ``` If you would like to search for a specific employee, simply provide the search criteria when calling the method: ```Javascript var criteria = { firstname : 'Broseph', lastname : 'McGee' }; client.getEmployees(criteria, function (err, data) { if (!err) { // we haz teh datas } }); ``` ### Attach Files to Employee * Not supported yet ### Retrieve Benefit Plan Enrollment Information ### Find Benefit Plans ```Javascript client.getBenefitPlans(function (err, data) { if (!err) { // we haz teh datas } }); ``` If you would like to search for a specific benefit plan, simply provide the search criteria when calling the method: ```Javascript var criteria = { benefitPlanId : 12 }; client.getBenefitPlans(criteria, function (err, data) { if (!err) { // we haz teh datas } }); ``` ### Access User Defined Employee Fields ```Javascript client.getFields(function (err, data) { if (!err) { // we haz teh datas } }); ``` ### Work With Compensation Data * Not supported yet ### Work With Existing Employee * Not supported yet ### Retrieve Employee Benefits ```Javascript var criteria = { employeeId : 1, asof : '2013-01-01' }; client.getEmployeeBenefits(criteria, function (err, data) { if (!err) { // we haz teh datas } }); ``` ### Retrieve Job Information for Employee ```Javascript var criteria = { employeeId : 1, asof : '2013-01-01' }; client.getEmployeeJobDetails(criteria, function (err, data) { if (!err) { // we haz teh datas } }); ``` ### Create New Hire * Not supported yet ### Retrieve Direct Deposit Information for Employee ```Javascript var criteria = { employeeId : 1 }; client.getDirectDeposits(criteria, function (err, data) { if (!err) { // we haz teh datas } }); ``` ### Retrieve HR Change Log ```Javascript var criteria = { from : '01/01/2013' }; client.getChanges(criteria, function (err, data) { if (!err) { // we haz teh datas } }); ``` ### Find COBRA Eligible Employees ```Javascript var criteria = { from : '01/01/2013' }; client.getCOBRAEligibleEmployees(criteria, function (err, data) { if (!err) { // we haz teh datas } }); ``` ### Find Emergency Contacts for Employee ```Javascript var criteria = { employeeId : 101 }; client.getEmergencyContacts(criteria, function (err, data) { if (!err) { // emergency contacts! } }); ``` ### Retrieve All Jobs in Company ```Javascript client.getJobs(function (err, data) { if (!err) { // we haz teh jobs } }); ``` If you would like to retrieve a specific job, provide a job ID: ```Javascript var criteria = { jobId : 101 }; client.getJobs(criteria, function (err, data) { if (!err) { // we haz teh specific job } }); ``` ### Retrieve All Locations in Company ```Javascript client.getLocations(function (err, data) { if (!err) { // we haz teh locations } }); ``` If you would like to retrieve a specific location, provide a location ID: ```Javascript var criteria = { locationId : 101 }; client.getLocations(criteria, function (err, data) { if (!err) { // we haz teh specific location } }); ``` ### Bulk Data Retrieval ```Javascript client.getRawData(function (err, data) { if (!err) { // we haz teh raw datas } }); ``` ## License MIT, see LICENSE