HR Software Employee Finder API Support

Employee Finder
Home > Resources > Employee Finder

This API allows you to find existing employees within Ascentis HR.

Resource URL

https://serverurl/path/v1.1/employees

Example Request
GET	https://serverurl/api/v1.1/employees

Request Content

lastname: Employee last name. The search will operate like an "ILIKE/LIKE" operator.

firstname: Employee first name. The search will operate like an "ILIKE/LIKE" operator.

middlename: Employee middle name. The search will operate like an "ILIKE/LIKE" operator.

empid: Employee ID/Number to search.

status: Employee status. The list of available status can be extracted from /fields (field name = EmpStatus)

divisionid: Employee division. The list of available disivions can be extracted from /fields (field name = DivisionID)

departmentid: Employee department. The list of available departments can be extracted from /fields (field name = DptID)

locationid: Employee location. The list of available locations can be extracted from /fields (field name = LocationID)

salarytype: Employee salary type. The list of available salary types can be extracted from /fields (field name = SalaryType)

jobtitleid: Employee job title. The list of available status can be extracted from /fields (field name = JobTitleID)

terminatedSince: Last X days if value is integer, or since date if value is date (availabe in v1.1 and higher)

hiredSince: same as terminatedSince (availabe in v1.1 and higher)

supervisor: true/false to limit search to supervisors or non-supervisors (available in v1.1 and higher)

Return Value

Http header "Accept" value -- "text/xml" or "application/xml" will return XML, otherwise JSON will be returned.

XML

<employees>
<employee>
    <uid>34</uid>
    <firstName>Kathryn</firstName>
    <lastName>Smith</lastName>
    <middleName />
    <ssn>555-55-5555</ssn>
    <employeeID>20116</employeeID>
    <birthDate>1973-10-03T00:00:00</birthDate>
    <gender>F</gender>
    <contact>
      <country>USA</country>
      <address1>150 120th AVE NE</address1>
      <address2 />
      <city>Bellevue</city>
      <state>WA</state>
      <zip>98005</zip>
      <home_phone>(555) 555-5555</home_phone>
      <work_phone>(555) 555-5555 x158</work_phone>
      <email>HRTestEmpWork@ascentis.com</email>
    </contact>
    <issupervisor>true</issupervisor>
    <supervisor>
      <uid>35</uid>
      <firstName>Matthew</firstName>
      <lastName>Taylor</lastName>
      <middleName />
      <employeeID>20213</employeeID>
      <birthDate xsi:nil="true" />
      <issupervisor>true</issupervisor>
    </supervisor>
  </employee>
     ...
</employees>

JSON

{
"employees": [
        {
            "uid": 34,
            "firstName": "Kathryn",
            "lastName": "Smith",
            "middleName": "",
            "ssn": "555-55-5555",
            "employeeID": "20116",
            "birthDate": "1973-10-03T00:00:00",
            "gender": "F",
            "contact": {
                "country": "USA",
                "address1": "150 120th AVE NE",
                "address2": "",
                "city": "Bellevue",
                "state": "WA",
                "zip": "98005",
                "home_phone": "(555) 555-5555",
                "work_phone": "(555) 555-5555",
                "email": "HRTestEmpWork@ascentis.com"
            },
            "issupervisor": true,
            "supervisor": {
                "uid": 35,
                "firstName": "Matthew",
                "lastName": "Taylor",
                "middleName": "",
                "employeeID": "20213",
                "issupervisor": true
            }
        },
        ...
    ]
}

Resource Information
Requires Authentication?	Yes
Response Formats	json xml
HTTP Methods	GET
Return Code	200: Response Completed 403: Incorrect Authorization 400: Bad Data