Darwinet API

Getting Started

The Thinkware Darwinet API is a Restful JSON API consumed via HTTP Requests.

Your {baseurl} is the same URL that you use to log in to Dnet. ex: https://d16.darwinet.com/111D2

All API endpoints require Authentication via an API Token. Please view the Authentication Instructions.

Authentication

Your API token is available for System level users at the following url:

https://{baseurl}/APIToken

or by clicking API Token under the gears in the top right.

API Tokens are like passwords..DO NOT share them.

Parameters
token
Authenticates API request - Required
This is the API key you will use to authenticate each request.
Example
https://{baseurl}/ClientAPI/{endpoint}?token={token}

Successful authentication will continue with your request. Any issues authenticating the API token will return an error.

{
  "status":"Error:",
  "message":"Unauthorized"
}

/GetClientCodes

Get Client Codes

Parameters
token
The API key used for authentication - Required
companyid
The Company ID of the employee - Required
clientid
The Client ID of the employee - Required
type
Code Type:
Departments, Divisions, EmployeeTypes, Jobs, Locations, Shifts, Statuses, Paycodes - Required

This Endpoint returns client code information

Example
https://{baseurl}/ClientAPI/GetClientCodes?token={token}&companyid=1&clientid=001&type=Departments

[
  {
    "CodeID": "001ADM",
    "CodeDescription": "administration"
  }, {
    "CodeID": "001SLS",
    "CodeDescription": "Sales"
  }
]

{
  "status":"Error:",
  "message":"Unauthorized"
}

/GetEmployee

Get Employee Information

Parameters
token
The API key used for authentication - Required
companyid
The Company ID of the employee - Required
clientid
The Client ID of the employee - Required
employeeid
The Employee ID of the employee - Required

This Endpoint includes EmploymentHistory, PTO, and DirectDepositItems

Example
https://{baseurl}/ClientAPI/GetEmployee?token={token}&companyid=1&clientid=001&employeeid=010010001

[
  {
    "FirstName": "Todd",
    "MiddleName": "",
    "LastName": "Washington",
    "BirthDate": "3/18/1978",
    "HomePhone": "5555555555",
    "HomeEmailAddress": "",
    "WorkPhone": "2222222222",
    "WorkEmailAddress": "xxxxxx@thinkwareinc.com",
    "Gender": "Male",
    "MaritalStatus": "",
    "Status": "Active",
    "AddressLine1": "1024 Birch Ave",
    "AddressLine2": "",
    "AddressLine3": "",
    "City": "Atlanta",
    "State": "GA",
    "ZipCode": "28741",
    "Division": "division (0001DIVISION)",
    "Department": "Sales (001SLS)",
    "Location": "",
    "Shift": "1",
    "Job": "Sales (SALES)",
    "Project": "N/A",
    "BenefitGroup": "N/A",
    "PayGroup": "N/A",
    "StandardHours": "",
    "EmployeeType": "Full Time Regular",
    "OriginalHireDate": "11/1/2015",
    "EmploymentHistory": null,
    "PTO": null,
    "DirectDepositItems": null
  }
]

{
  "status":"Error:",
  "message":"Unauthorized"
}

/CreateNewEmployee

Create a new Darwinet Employee

Parameters
token
The API key used for authentication - Required
companyid
The Company ID of the employee - Required
clientid
The Client ID of the employee - Required
employeeid
The Employee ID of the employee - Required - if manual employee ID creation.

Required Fields listed below should be submitted during your POST request

Parameters
FirstName
The First Name of the employee - Required
LastName
The Last Name of the employee - Required
SSN
The Social Security of the employee - Required
EEStatus
The Status of the employee - Required
Department
The Department of the employee - Required
Position
The Position of the employee - Required
WorkHoursPerYear
The Work Hours per year of the employee - Required
WorkState
The WorkState of the employee - Required
ex: OH
DOB
The Date of Birth of the employee - Required
EEClass
The Employee Class of the employee
Email
The Email of the employee - Required - if using on boarding
Gender
The Gender of the employee
Ethnicity
The Ethnicity of the employee
PayPeriod
The Pay Period of the employee
DueDate
The Onboarding due date

Fields listed below are Required when NOT using onboarding

Parameters
CreateUser (bool)
Create a user when adding a new employee - Required
UserID
The Employee ID of the employee - Required if creating a user
Password
The Employee ID of the employee - Required if creating a user
RoleID
The Role ID of the employee - Required if creating a user
Example
https://{baseurl}/ClientAPI/CreateNewEmployee?token={token}&companyid=1&clientid=001

[
  {
      "employeeid": "010020115"
  }
]

{
  "status":"Error:",
  "message":"An error has occured."
}

/GetSSOToken

Get Single Sign On Token

Parameters
token
The API key used for authentication - Required
userid
The UserID of the user you want to authenticate - Required

This endpoint will provide a token that can be used during single sign on to authenticate the user.

Example
https://{baseurl}/ClientAPI/GetSSOToken?token={token}&userid=exampleid

To use this SSO Token for Single Sign On please see SSO POST

{
  "ssotoken": "2bdcc5208a4e45638f7a647fe69ef4a5467de101b4294ec49ce2cfceb4d15aacb9b530cc220e47c0bbcb976bfcd413028ed0b6c5a252443fa2834ecf26ba4b0d"
}

{
  "status":"Error:",
  "message":"Unauthorized"
}

/SSO

Single Sign On

Parameters
UserID
The UserID of the user you want to authenticate - Required
SSOToken
The token supplied by the /GetSSOToken endpoint - Required

This endpoint will provide single sign on into Darwinet 2.0.

Example
https://{baseurl}/ClientAPI/SSO?userid={userid}&ssotoken={ssotoken}

Send the required information with your POST request

Upon completion you will be redirected to the user’s dashboard.

{
  "status":"Error:",
  "message":"Invalid Token."
}
or
{
  "status":"Error:",
  "message":"User does not exist."
}